anoopmb
/
frappe
1
0
Fork 0
Código Issues 0 Pull requests 0 Versões 0 Wiki Atividade
Ver código fonte

[docs] remove /docs/current from repo, since they will be created during build

version-14
Rushabh Mehta 9 anos atrás
pai
44e8dfeb0a
commit
8014979947
100 arquivos alterados com 1 adições e 17682 exclusões
Visão dividida
Opções de diferenças
Mostrar estatísticas Baixar arquivo de patch Baixar arquivo de diferenças
  1. +1
    -0
      .gitignore
  2. +0
    -34
      frappe/docs/current/api/config/frappe.config.core.html
  3. +0
    -34
      frappe/docs/current/api/config/frappe.config.desk.html
  4. +0
    -34
      frappe/docs/current/api/config/frappe.config.desktop.html
  5. +0
    -34
      frappe/docs/current/api/config/frappe.config.docs.html
  6. +0
    -18
      frappe/docs/current/api/config/frappe.config.html
  7. +0
    -34
      frappe/docs/current/api/config/frappe.config.setup.html
  8. +0
    -34
      frappe/docs/current/api/config/frappe.config.website.html
  9. +0
    -19
      frappe/docs/current/api/config/index.html
  10. +0
    -7
      frappe/docs/current/api/config/index.txt
  11. +0
    -18
      frappe/docs/current/api/core/frappe.core.html
  12. +0
    -98
      frappe/docs/current/api/core/frappe.core.notifications.html
  13. +0
    -19
      frappe/docs/current/api/core/index.html
  14. +0
    -2
      frappe/docs/current/api/core/index.txt
  15. +0
    -18
      frappe/docs/current/api/custom/frappe.custom.html
  16. +0
    -19
      frappe/docs/current/api/custom/index.html
  17. +0
    -1
      frappe/docs/current/api/custom/index.txt
  18. +0
    -157
      frappe/docs/current/api/desk/form/frappe.desk.form.assign_to.html
  19. +0
    -18
      frappe/docs/current/api/desk/form/frappe.desk.form.html
  20. +0
    -107
      frappe/docs/current/api/desk/form/frappe.desk.form.linked_with.html
  21. +0
    -188
      frappe/docs/current/api/desk/form/frappe.desk.form.load.html
  22. +0
    -277
      frappe/docs/current/api/desk/form/frappe.desk.form.meta.html
  23. +0
    -52
      frappe/docs/current/api/desk/form/frappe.desk.form.run_method.html
  24. +0
    -86
      frappe/docs/current/api/desk/form/frappe.desk.form.save.html
  25. +0
    -47
      frappe/docs/current/api/desk/form/frappe.desk.form.test_form.html
  26. +0
    -90
      frappe/docs/current/api/desk/form/frappe.desk.form.utils.html
  27. +0
    -19
      frappe/docs/current/api/desk/form/index.html
  28. +0
    -9
      frappe/docs/current/api/desk/form/index.txt
  29. +0
    -52
      frappe/docs/current/api/desk/frappe.desk.calendar.html
  30. +0
    -70
      frappe/docs/current/api/desk/frappe.desk.desk_page.html
  31. +0
    -18
      frappe/docs/current/api/desk/frappe.desk.html
  32. +0
    -96
      frappe/docs/current/api/desk/frappe.desk.like.html
  33. +0
    -261
      frappe/docs/current/api/desk/frappe.desk.moduleview.html
  34. +0
    -196
      frappe/docs/current/api/desk/frappe.desk.notifications.html
  35. +0
    -183
      frappe/docs/current/api/desk/frappe.desk.query_builder.html
  36. +0
    -193
      frappe/docs/current/api/desk/frappe.desk.query_report.html
  37. +0
    -36
      frappe/docs/current/api/desk/frappe.desk.report_dump.html
  38. +0
    -220
      frappe/docs/current/api/desk/frappe.desk.reportview.html
  39. +0
    -102
      frappe/docs/current/api/desk/frappe.desk.search.html
  40. +0
    -213
      frappe/docs/current/api/desk/frappe.desk.tags.html
  41. +0
    -19
      frappe/docs/current/api/desk/index.html
  42. +0
    -12
      frappe/docs/current/api/desk/index.txt
  43. +0
    -197
      frappe/docs/current/api/email/frappe.email.bulk.html
  44. +0
    -293
      frappe/docs/current/api/email/frappe.email.email_body.html
  45. +0
    -100
      frappe/docs/current/api/email/frappe.email.html
  46. +0
    -731
      frappe/docs/current/api/email/frappe.email.receive.html
  47. +0
    -139
      frappe/docs/current/api/email/frappe.email.smtp.html
  48. +0
    -19
      frappe/docs/current/api/email/index.html
  49. +0
    -5
      frappe/docs/current/api/email/index.txt
  50. +0
    -1682
      frappe/docs/current/api/frappe.__init__.html
  51. +0
    -18
      frappe/docs/current/api/frappe.__version__.html
  52. +0
    -53
      frappe/docs/current/api/frappe.api.html
  53. +0
    -123
      frappe/docs/current/api/frappe.app.html
  54. +0
    -395
      frappe/docs/current/api/frappe.async.html
  55. +0
    -501
      frappe/docs/current/api/frappe.auth.html
  56. +0
    -178
      frappe/docs/current/api/frappe.boot.html
  57. +0
    -178
      frappe/docs/current/api/frappe.build.html
  58. +0
    -261
      frappe/docs/current/api/frappe.celery_app.html
  59. +0
    -288
      frappe/docs/current/api/frappe.client.html
  60. +0
    -162
      frappe/docs/current/api/frappe.commands.html
  61. +0
    -938
      frappe/docs/current/api/frappe.database.html
  62. +0
    -326
      frappe/docs/current/api/frappe.defaults.html
  63. +0
    -498
      frappe/docs/current/api/frappe.exceptions.html
  64. +0
    -399
      frappe/docs/current/api/frappe.frappeclient.html
  65. +0
    -244
      frappe/docs/current/api/frappe.handler.html
  66. +0
    -18
      frappe/docs/current/api/frappe.hooks.html
  67. +0
    -370
      frappe/docs/current/api/frappe.installer.html
  68. +0
    -61
      frappe/docs/current/api/frappe.middlewares.html
  69. +0
    -332
      frappe/docs/current/api/frappe.permissions.html
  70. +0
    -18
      frappe/docs/current/api/frappe.pythonrc.html
  71. +0
    -409
      frappe/docs/current/api/frappe.sessions.html
  72. +0
    -63
      frappe/docs/current/api/frappe.setup_logging.html
  73. +0
    -160
      frappe/docs/current/api/frappe.share.html
  74. +0
    -98
      frappe/docs/current/api/frappe.tasks.html
  75. +0
    -226
      frappe/docs/current/api/frappe.test_runner.html
  76. +0
    -696
      frappe/docs/current/api/frappe.translate.html
  77. +0
    -100
      frappe/docs/current/api/geo/frappe.geo.country_info.html
  78. +0
    -18
      frappe/docs/current/api/geo/frappe.geo.html
  79. +0
    -19
      frappe/docs/current/api/geo/index.html
  80. +0
    -2
      frappe/docs/current/api/geo/index.txt
  81. +0
    -20
      frappe/docs/current/api/index.html
  82. +0
    -27
      frappe/docs/current/api/index.txt
  83. +0
    -18
      frappe/docs/current/api/integrations/frappe.integrations.html
  84. +0
    -19
      frappe/docs/current/api/integrations/index.html
  85. +0
    -1
      frappe/docs/current/api/integrations/index.txt
  86. +0
    -643
      frappe/docs/current/api/model/frappe.model.base_document.html
  87. +0
    -146
      frappe/docs/current/api/model/frappe.model.create_new.html
  88. +0
    -350
      frappe/docs/current/api/model/frappe.model.db_query.html
  89. +0
    -597
      frappe/docs/current/api/model/frappe.model.db_schema.html
  90. +0
    -194
      frappe/docs/current/api/model/frappe.model.delete_doc.html
  91. +0
    -98
      frappe/docs/current/api/model/frappe.model.docfield.html
  92. +0
    -788
      frappe/docs/current/api/model/frappe.model.document.html
  93. +0
    -87
      frappe/docs/current/api/model/frappe.model.html
  94. +0
    -98
      frappe/docs/current/api/model/frappe.model.mapper.html
  95. +0
    -489
      frappe/docs/current/api/model/frappe.model.meta.html
  96. +0
    -209
      frappe/docs/current/api/model/frappe.model.naming.html
  97. +0
    -285
      frappe/docs/current/api/model/frappe.model.rename_doc.html
  98. +0
    -66
      frappe/docs/current/api/model/frappe.model.sync.html
  99. +0
    -66
      frappe/docs/current/api/model/frappe.model.workflow.html
  100. +0
    -19
      frappe/docs/current/api/model/index.html

+ 1
- 0
.gitignore Ver arquivo

@@ -8,3 +8,4 @@ locale
*.egg-info
dist/
build/
frappe/docs/current

+ 0
- 34
frappe/docs/current/api/config/frappe.config.core.html Ver arquivo

@@ -1,34 +0,0 @@
<!-- title: frappe.config.core --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/config/core.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.core.get_data" href="#frappe.config.core.get_data" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.config.core.<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
- 34
frappe/docs/current/api/config/frappe.config.desk.html Ver arquivo

@@ -1,34 +0,0 @@
<!-- title: frappe.config.desk --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/config/desk.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.desk.get_data" href="#frappe.config.desk.get_data" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.config.desk.<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
- 34
frappe/docs/current/api/config/frappe.config.desktop.html Ver arquivo

@@ -1,34 +0,0 @@
<!-- title: frappe.config.desktop --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 34
frappe/docs/current/api/config/frappe.config.docs.html Ver arquivo

@@ -1,34 +0,0 @@
<!-- title: frappe.config.docs --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 18
frappe/docs/current/api/config/frappe.config.html Ver arquivo

@@ -1,18 +0,0 @@
<!-- title: frappe.config --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/config.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>

</div>







<!-- autodoc -->

+ 0
- 34
frappe/docs/current/api/config/frappe.config.setup.html Ver arquivo

@@ -1,34 +0,0 @@
<!-- title: frappe.config.setup --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 34
frappe/docs/current/api/config/frappe.config.website.html Ver arquivo

@@ -1,34 +0,0 @@
<!-- title: frappe.config.website --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 19
frappe/docs/current/api/config/index.html Ver arquivo

@@ -1,19 +0,0 @@
<!-- title: config -->


<div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/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
- 7
frappe/docs/current/api/config/index.txt Ver arquivo

@@ -1,7 +0,0 @@
frappe.config.core
frappe.config.desk
frappe.config.desktop
frappe.config.docs
frappe.config
frappe.config.setup
frappe.config.website

+ 0
- 18
frappe/docs/current/api/core/frappe.core.html Ver arquivo

@@ -1,18 +0,0 @@
<!-- title: frappe.core --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/core.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>

</div>







<!-- autodoc -->

+ 0
- 98
frappe/docs/current/api/core/frappe.core.notifications.html Ver arquivo

@@ -1,98 +0,0 @@
<!-- title: frappe.core.notifications --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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>


<p class="docs-attr-name">
<a name="frappe.core.notifications.get_unseen_likes" href="#frappe.core.notifications.get_unseen_likes" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.core.notifications.<b>get_unseen_likes</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p>Returns count of unseen likes</p>
</div>
<br>




<!-- autodoc -->

+ 0
- 19
frappe/docs/current/api/core/index.html Ver arquivo

@@ -1,19 +0,0 @@
<!-- title: core -->


<div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/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
- 2
frappe/docs/current/api/core/index.txt Ver arquivo

@@ -1,2 +0,0 @@
frappe.core
frappe.core.notifications

+ 0
- 18
frappe/docs/current/api/custom/frappe.custom.html Ver arquivo

@@ -1,18 +0,0 @@
<!-- title: frappe.custom --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/custom.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>

</div>







<!-- autodoc -->

+ 0
- 19
frappe/docs/current/api/custom/index.html Ver arquivo

@@ -1,19 +0,0 @@
<!-- title: custom -->


<div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/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
- 1
frappe/docs/current/api/custom/index.txt Ver arquivo

@@ -1 +0,0 @@
frappe.custom

+ 0
- 157
frappe/docs/current/api/desk/form/frappe.desk.form.assign_to.html Ver arquivo

@@ -1,157 +0,0 @@
<!-- title: frappe.desk.form.assign_to --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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>





<h3 style="font-weight: normal;">Class <b>DuplicateToDoError</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><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><span class="label label-info">Public API</span>
<br><code>/api/method/frappe.desk.form.assign_to.add_multiple</code>
</p>
<p class="docs-attr-name">
<a name="frappe.desk.form.assign_to.add_multiple" href="#frappe.desk.form.assign_to.add_multiple" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.form.assign_to.<b>add_multiple</b>
<i class="text-muted">(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="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>


<p class="docs-attr-name">
<a name="frappe.desk.form.assign_to.remove_from_todo_if_already_assigned" href="#frappe.desk.form.assign_to.remove_from_todo_if_already_assigned" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.form.assign_to.<b>remove_from_todo_if_already_assigned</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>




<!-- autodoc -->

+ 0
- 18
frappe/docs/current/api/desk/form/frappe.desk.form.html Ver arquivo

@@ -1,18 +0,0 @@
<!-- title: frappe.desk.form --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 107
frappe/docs/current/api/desk/form/frappe.desk.form.linked_with.html Ver arquivo

@@ -1,107 +0,0 @@
<!-- title: frappe.desk.form.linked_with --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 188
frappe/docs/current/api/desk/form/frappe.desk.form.load.html Ver arquivo

@@ -1,188 +0,0 @@
<!-- title: frappe.desk.form.load --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 277
frappe/docs/current/api/desk/form/frappe.desk.form.meta.html Ver arquivo

@@ -1,277 +0,0 @@
<!-- title: frappe.desk.form.meta --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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_code_files_via_hooks" href="#frappe.desk.form.meta.get_code_files_via_hooks" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.form.meta.<b>get_code_files_via_hooks</b>
<i class="text-muted">(hook, 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.meta.get_js" href="#frappe.desk.form.meta.get_js" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.form.meta.<b>get_js</b>
<i class="text-muted">(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="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
- 52
frappe/docs/current/api/desk/form/frappe.desk.form.run_method.html Ver arquivo

@@ -1,52 +0,0 @@
<!-- title: frappe.desk.form.run_method --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 86
frappe/docs/current/api/desk/form/frappe.desk.form.save.html Ver arquivo

@@ -1,86 +0,0 @@
<!-- title: frappe.desk.form.save --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 47
frappe/docs/current/api/desk/form/frappe.desk.form.test_form.html Ver arquivo

@@ -1,47 +0,0 @@
<!-- title: frappe.desk.form.test_form --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 90
frappe/docs/current/api/desk/form/frappe.desk.form.utils.html Ver arquivo

@@ -1,90 +0,0 @@
<!-- title: frappe.desk.form.utils --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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_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
- 19
frappe/docs/current/api/desk/form/index.html Ver arquivo

@@ -1,19 +0,0 @@
<!-- title: form -->


<div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/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
- 9
frappe/docs/current/api/desk/form/index.txt Ver arquivo

@@ -1,9 +0,0 @@
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
- 52
frappe/docs/current/api/desk/frappe.desk.calendar.html Ver arquivo

@@ -1,52 +0,0 @@
<!-- title: frappe.desk.calendar --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 70
frappe/docs/current/api/desk/frappe.desk.desk_page.html Ver arquivo

@@ -1,70 +0,0 @@
<!-- title: frappe.desk.desk_page --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 18
frappe/docs/current/api/desk/frappe.desk.html Ver arquivo

@@ -1,18 +0,0 @@
<!-- title: frappe.desk --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/desk.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>

</div>







<!-- autodoc -->

+ 0
- 96
frappe/docs/current/api/desk/frappe.desk.like.html Ver arquivo

@@ -1,96 +0,0 @@
<!-- title: frappe.desk.like --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/desk/like.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.like._toggle_like" href="#frappe.desk.like._toggle_like" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.like.<b>_toggle_like</b>
<i class="text-muted">(doctype, name, add, user=None)</i>
</p>
<div class="docs-attr-desc"><p>Same as toggle_like but hides param <code>user</code> from API</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.desk.like.add_comment" href="#frappe.desk.like.add_comment" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.like.<b>add_comment</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.like.remove_like" href="#frappe.desk.like.remove_like" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.like.<b>remove_like</b>
<i class="text-muted">(doctype, name)</i>
</p>
<div class="docs-attr-desc"><p>Remove previous Like</p>
</div>
<br>


<p><span class="label label-info">Public API</span>
<br><code>/api/method/frappe.desk.like.toggle_like</code>
</p>
<p class="docs-attr-name">
<a name="frappe.desk.like.toggle_like" href="#frappe.desk.like.toggle_like" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.like.<b>toggle_like</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>__liked_by</code> property of the given document.
If column does not exist, will add it in the database.</p>

<p>The <code>_liked_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 like</li>
<li><strong><code>name</code></strong> - Name of the document to like</li>
<li><strong><code>add</code></strong> - <code>Yes</code> if like is to be added. If not <code>Yes</code> the like will be removed.</li>
</ul>
</div>
<br>




<!-- autodoc -->

+ 0
- 261
frappe/docs/current/api/desk/frappe.desk.moduleview.html Ver arquivo

@@ -1,261 +0,0 @@
<!-- title: frappe.desk.moduleview --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 196
frappe/docs/current/api/desk/frappe.desk.notifications.html Ver arquivo

@@ -1,196 +0,0 @@
<!-- title: frappe.desk.notifications --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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" href="#frappe.desk.notifications.get_notifications_for" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.notifications.<b>get_notifications_for</b>
<i class="text-muted">(notification_type, 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_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>Notifications for DocTypes</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>Notifications for modules</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.desk.notifications.get_notifications_for_other" href="#frappe.desk.notifications.get_notifications_for_other" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.notifications.<b>get_notifications_for_other</b>
<i class="text-muted">(config, notification_count)</i>
</p>
<div class="docs-attr-desc"><p>Notifications for other items</p>
</div>
<br>




<!-- autodoc -->

+ 0
- 183
frappe/docs/current/api/desk/frappe.desk.query_builder.html Ver arquivo

@@ -1,183 +0,0 @@
<!-- title: frappe.desk.query_builder --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 193
frappe/docs/current/api/desk/frappe.desk.query_report.html Ver arquivo

@@ -1,193 +0,0 @@
<!-- title: frappe.desk.query_report --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 36
frappe/docs/current/api/desk/frappe.desk.report_dump.html Ver arquivo

@@ -1,36 +0,0 @@
<!-- title: frappe.desk.report_dump --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 220
frappe/docs/current/api/desk/frappe.desk.reportview.html Ver arquivo

@@ -1,220 +0,0 @@
<!-- title: frappe.desk.reportview --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 102
frappe/docs/current/api/desk/frappe.desk.search.html Ver arquivo

@@ -1,102 +0,0 @@
<!-- title: frappe.desk.search --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 213
frappe/docs/current/api/desk/frappe.desk.tags.html Ver arquivo

@@ -1,213 +0,0 @@
<!-- title: frappe.desk.tags --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 19
frappe/docs/current/api/desk/index.html Ver arquivo

@@ -1,19 +0,0 @@
<!-- title: desk -->


<div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/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
- 12
frappe/docs/current/api/desk/index.txt Ver arquivo

@@ -1,12 +0,0 @@
frappe.desk.calendar
frappe.desk.desk_page
frappe.desk
frappe.desk.like
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.tags

+ 0
- 197
frappe/docs/current/api/email/frappe.email.bulk.html Ver arquivo

@@ -1,197 +0,0 @@
<!-- title: frappe.email.bulk --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 293
frappe/docs/current/api/email/frappe.email.email_body.html Ver arquivo

@@ -1,293 +0,0 @@
<!-- title: frappe.email.email_body --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 100
frappe/docs/current/api/email/frappe.email.html Ver arquivo

@@ -1,100 +0,0 @@
<!-- title: frappe.email --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 731
frappe/docs/current/api/email/frappe.email.receive.html Ver arquivo

@@ -1,731 +0,0 @@
<!-- title: frappe.email.receive --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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>EmailServer</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="connect_imap" href="#connect_imap" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>connect_imap</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Connect to IMAP</p>
</div>
<br>

<p class="docs-attr-name">
<a name="connect_pop" href="#connect_pop" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>connect_pop</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_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="get_new_mails" href="#get_new_mails" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_new_mails</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Return list of new mails</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, message_meta, msg_num=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" 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_message_limits" href="#validate_message_limits" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_message_limits</b>
<i class="text-muted">(self, message_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>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>Timed_IMAP4</b></h3>
<p style="padding-left: 30px;"><i>Inherits from frappe.email.receive.TimerMixin, imaplib.IMAP4</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_IMAP4_SSL</b></h3>
<p style="padding-left: 30px;"><i>Inherits from frappe.email.receive.TimerMixin, imaplib.IMAP4_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>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
- 139
frappe/docs/current/api/email/frappe.email.smtp.html Ver arquivo

@@ -1,139 +0,0 @@
<!-- title: frappe.email.smtp --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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="replace_sender_in_email" href="#replace_sender_in_email" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>replace_sender_in_email</b>
<i class="text-muted">(self, email)</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
- 19
frappe/docs/current/api/email/index.html Ver arquivo

@@ -1,19 +0,0 @@
<!-- title: email -->


<div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/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
- 5
frappe/docs/current/api/email/index.txt Ver arquivo

@@ -1,5 +0,0 @@
frappe.email.bulk
frappe.email.email_body
frappe.email
frappe.email.receive
frappe.email.smtp

+ 0
- 1682
frappe/docs/current/api/frappe.__init__.html
Diferenças do arquivo suprimidas por serem muito extensas
Ver arquivo


+ 0
- 18
frappe/docs/current/api/frappe.__version__.html Ver arquivo

@@ -1,18 +0,0 @@
<!-- title: frappe.__version__ --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/__version__.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>

</div>







<!-- autodoc -->

+ 0
- 53
frappe/docs/current/api/frappe.api.html Ver arquivo

@@ -1,53 +0,0 @@
<!-- title: frappe.api --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 123
frappe/docs/current/api/frappe.app.html Ver arquivo

@@ -1,123 +0,0 @@
<!-- title: frappe.app --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 395
frappe/docs/current/api/frappe.async.html Ver arquivo

@@ -1,395 +0,0 @@
<!-- title: frappe.async --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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, after_commit=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>
<li><strong><code>after_commit</code></strong> - (default False) will emit after current transaction is committed</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
- 501
frappe/docs/current/api/frappe.auth.html Ver arquivo

@@ -1,501 +0,0 @@
<!-- title: frappe.auth --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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>


<p class="docs-attr-name">
<a name="frappe.auth.get_website_user_home_page" href="#frappe.auth.get_website_user_home_page" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.auth.<b>get_website_user_home_page</b>
<i class="text-muted">(user)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>




<!-- autodoc -->

+ 0
- 178
frappe/docs/current/api/frappe.boot.html Ver arquivo

@@ -1,178 +0,0 @@
<!-- title: frappe.boot --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 178
frappe/docs/current/api/frappe.build.html Ver arquivo

@@ -1,178 +0,0 @@
<!-- title: frappe.build --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 261
frappe/docs/current/api/frappe.celery_app.html Ver arquivo

@@ -1,261 +0,0 @@
<!-- title: frappe.celery_app --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 288
frappe/docs/current/api/frappe.client.html Ver arquivo

@@ -1,288 +0,0 @@
<!-- title: frappe.client --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 162
frappe/docs/current/api/frappe.commands.html Ver arquivo

@@ -1,162 +0,0 @@
<!-- title: frappe.commands --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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._build_docs_once" href="#frappe.commands._build_docs_once" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.commands.<b>_build_docs_once</b>
<i class="text-muted">(site, app, docs_version, target, local, only_content_updated=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.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
- 938
frappe/docs/current/api/frappe.database.html Ver arquivo

@@ -1,938 +0,0 @@
<!-- title: frappe.database --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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> [=, !=, &gt;, &gt;=, &lt;, &lt;=] %(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, percent=True)</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_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
- 326
frappe/docs/current/api/frappe.defaults.html Ver arquivo

@@ -1,326 +0,0 @@
<!-- title: frappe.defaults --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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.is_a_user_permission_key" href="#frappe.defaults.is_a_user_permission_key" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.defaults.<b>is_a_user_permission_key</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.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
- 498
frappe/docs/current/api/frappe.exceptions.html Ver arquivo

@@ -1,498 +0,0 @@
<!-- title: frappe.exceptions --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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>AppNotInstalledError</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>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>IncorrectSitePath</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
- 399
frappe/docs/current/api/frappe.frappeclient.html Ver arquivo

@@ -1,399 +0,0 @@
<!-- title: frappe.frappeclient --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 244
frappe/docs/current/api/frappe.handler.html Ver arquivo

@@ -1,244 +0,0 @@
<!-- title: frappe.handler --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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 class="docs-attr-name">
<a name="frappe.handler.is_whitelisted" href="#frappe.handler.is_whitelisted" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.handler.<b>is_whitelisted</b>
<i class="text-muted">(method)</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.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&amp;doctype={doctype}&amp;name={name}&amp;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
- 18
frappe/docs/current/api/frappe.hooks.html Ver arquivo

@@ -1,18 +0,0 @@
<!-- title: frappe.hooks --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/hooks.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>

</div>







<!-- autodoc -->

+ 0
- 370
frappe/docs/current/api/frappe.installer.html Ver arquivo

@@ -1,370 +0,0 @@
<!-- title: frappe.installer --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 61
frappe/docs/current/api/frappe.middlewares.html Ver arquivo

@@ -1,61 +0,0 @@
<!-- title: frappe.middlewares --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 332
frappe/docs/current/api/frappe.permissions.html Ver arquivo

@@ -1,332 +0,0 @@
<!-- title: frappe.permissions --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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
- 18
frappe/docs/current/api/frappe.pythonrc.html Ver arquivo

@@ -1,18 +0,0 @@
<!-- title: frappe.pythonrc --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/pythonrc.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>

</div>







<!-- autodoc -->

+ 0
- 409
frappe/docs/current/api/frappe.sessions.html Ver arquivo

@@ -1,409 +0,0 @@
<!-- title: frappe.sessions --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/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, device=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.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 -->

+ 0
- 63
frappe/docs/current/api/frappe.setup_logging.html Ver arquivo

@@ -1,63 +0,0 @@
<!-- title: frappe.setup_logging --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/setup_logging.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>ContextFilter</b></h3>
<p style="padding-left: 30px;"><i>Inherits from logging.Filter</i></h4>
<div class="docs-attr-desc"><p>This is a filter which injects request information (if available) into the log.</p>
</div>
<div style="padding-left: 30px;">
<p class="docs-attr-name">
<a name="filter" href="#filter" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>filter</b>
<i class="text-muted">(self, record)</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.setup_logging.setup_logging" href="#frappe.setup_logging.setup_logging" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.setup_logging.<b>setup_logging</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
- 160
frappe/docs/current/api/frappe.share.html Ver arquivo

@@ -1,160 +0,0 @@
<!-- title: frappe.share --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/share.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.share.add</code>
</p>
<p class="docs-attr-name">
<a name="frappe.share.add" href="#frappe.share.add" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.share.<b>add</b>
<i class="text-muted">(doctype, name, user=None, read=1, write=0, share=0, everyone=0, flags=None)</i>
</p>
<div class="docs-attr-desc"><p>Share the given document with a user.</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.share.check_share_permission" href="#frappe.share.check_share_permission" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.share.<b>check_share_permission</b>
<i class="text-muted">(doctype, name)</i>
</p>
<div class="docs-attr-desc"><p>Check if the user can share with other users</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.share.get_share_name" href="#frappe.share.get_share_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.share.<b>get_share_name</b>
<i class="text-muted">(doctype, name, user, everyone)</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.share.get_shared" href="#frappe.share.get_shared" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.share.<b>get_shared</b>
<i class="text-muted">(doctype, user=None, rights=None)</i>
</p>
<div class="docs-attr-desc"><p>Get list of shared document names for given user and DocType.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>doctype</code></strong> - DocType of which shared names are queried.</li>
<li><strong><code>user</code></strong> - User for which shared names are queried.</li>
<li><strong><code>rights</code></strong> - List of rights for which the document is shared. List of <code>read</code>, <code>write</code>, <code>share</code></li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.share.get_shared_doctypes" href="#frappe.share.get_shared_doctypes" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.share.<b>get_shared_doctypes</b>
<i class="text-muted">(user=None)</i>
</p>
<div class="docs-attr-desc"><p>Return list of doctypes in which documents are shared for the given user.</p>
</div>
<br>


<p><span class="label label-info">Public API</span>
<br><code>/api/method/frappe.share.get_users</code>
</p>
<p class="docs-attr-name">
<a name="frappe.share.get_users" href="#frappe.share.get_users" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.share.<b>get_users</b>
<i class="text-muted">(doctype, name, fields=*)</i>
</p>
<div class="docs-attr-desc"><p>Get list of users with which this document is shared</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.share.remove" href="#frappe.share.remove" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.share.<b>remove</b>
<i class="text-muted">(doctype, name, user, flags=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.share.set_permission</code>
</p>
<p class="docs-attr-name">
<a name="frappe.share.set_permission" href="#frappe.share.set_permission" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.share.<b>set_permission</b>
<i class="text-muted">(doctype, name, user, permission_to, value=1, everyone=0)</i>
</p>
<div class="docs-attr-desc"><p>Set share permission.</p>
</div>
<br>




<!-- autodoc -->

+ 0
- 98
frappe/docs/current/api/frappe.tasks.html Ver arquivo

@@ -1,98 +0,0 @@
<!-- title: frappe.tasks --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/tasks.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.tasks.get_active_queues" href="#frappe.tasks.get_active_queues" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.tasks.<b>get_active_queues</b>
<i class="text-muted">(app, worker)</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.tasks.get_required_queues" href="#frappe.tasks.get_required_queues" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.tasks.<b>get_required_queues</b>
<i class="text-muted">(app, prefix=)</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.tasks.get_workers" href="#frappe.tasks.get_workers" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.tasks.<b>get_workers</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.tasks.is_site_in_maintenance_mode" href="#frappe.tasks.is_site_in_maintenance_mode" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.tasks.<b>is_site_in_maintenance_mode</b>
<i class="text-muted">(queue, prefix)</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.tasks.sync_worker" href="#frappe.tasks.sync_worker" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.tasks.<b>sync_worker</b>
<i class="text-muted">(app, worker, prefix=)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>




<!-- autodoc -->

+ 0
- 226
frappe/docs/current/api/frappe.test_runner.html Ver arquivo

@@ -1,226 +0,0 @@
<!-- title: frappe.test_runner --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/test_runner.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.test_runner._add_test" href="#frappe.test_runner._add_test" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.test_runner.<b>_add_test</b>
<i class="text-muted">(path, filename, verbose, test_suite=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.test_runner._run_unittest" href="#frappe.test_runner._run_unittest" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.test_runner.<b>_run_unittest</b>
<i class="text-muted">(module, verbose=False, tests=())</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.test_runner.get_dependencies" href="#frappe.test_runner.get_dependencies" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.test_runner.<b>get_dependencies</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.test_runner.get_modules" href="#frappe.test_runner.get_modules" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.test_runner.<b>get_modules</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.test_runner.main" href="#frappe.test_runner.main" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.test_runner.<b>main</b>
<i class="text-muted">(app=None, module=None, doctype=None, verbose=False, tests=(), force=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.test_runner.make_test_objects" href="#frappe.test_runner.make_test_objects" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.test_runner.<b>make_test_objects</b>
<i class="text-muted">(doctype, test_records, verbose=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.test_runner.make_test_records" href="#frappe.test_runner.make_test_records" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.test_runner.<b>make_test_records</b>
<i class="text-muted">(doctype, verbose=0, force=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.test_runner.make_test_records_for_doctype" href="#frappe.test_runner.make_test_records_for_doctype" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.test_runner.<b>make_test_records_for_doctype</b>
<i class="text-muted">(doctype, verbose=0, force=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.test_runner.print_mandatory_fields" href="#frappe.test_runner.print_mandatory_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.test_runner.<b>print_mandatory_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 class="docs-attr-name">
<a name="frappe.test_runner.run_all_tests" href="#frappe.test_runner.run_all_tests" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.test_runner.<b>run_all_tests</b>
<i class="text-muted">(app=None, 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.test_runner.run_tests_for_doctype" href="#frappe.test_runner.run_tests_for_doctype" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.test_runner.<b>run_tests_for_doctype</b>
<i class="text-muted">(doctype, verbose=False, tests=(), force=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.test_runner.run_tests_for_module" href="#frappe.test_runner.run_tests_for_module" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.test_runner.<b>run_tests_for_module</b>
<i class="text-muted">(module, verbose=False, tests=())</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.test_runner.set_test_email_config" href="#frappe.test_runner.set_test_email_config" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.test_runner.<b>set_test_email_config</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
- 696
frappe/docs/current/api/frappe.translate.html Ver arquivo

@@ -1,696 +0,0 @@
<!-- title: frappe.translate --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/translate.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.translate._get_messages_from_page_or_report" href="#frappe.translate._get_messages_from_page_or_report" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>_get_messages_from_page_or_report</b>
<i class="text-muted">(doctype, name, module=None)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.add_lang_dict" href="#frappe.translate.add_lang_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>add_lang_dict</b>
<i class="text-muted">(code)</i>
</p>
<div class="docs-attr-desc"><p>Extracts messages and returns Javascript code snippet to be appened at the end
of the given script</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>code</code></strong> - Javascript code snippet to which translations needs to be appended.</li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.clear_cache" href="#frappe.translate.clear_cache" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>clear_cache</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p>Clear all translation assets from :meth:<code>frappe.cache</code></p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.deduplicate_messages" href="#frappe.translate.deduplicate_messages" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>deduplicate_messages</b>
<i class="text-muted">(messages)</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.translate.extract_messages_from_code" href="#frappe.translate.extract_messages_from_code" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>extract_messages_from_code</b>
<i class="text-muted">(code, is_py=False)</i>
</p>
<div class="docs-attr-desc"><p>Extracts translatable srings from a code file</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>code</code></strong> - code from which translatable files are to be extracted</li>
<li><strong><code>is_py</code></strong> - include messages in triple quotes e.g. <code>_('''message''')</code></li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_all_languages" href="#frappe.translate.get_all_languages" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_all_languages</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p>Returns all language codes ar, ch etc</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_all_messages_from_js_files" href="#frappe.translate.get_all_messages_from_js_files" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_all_messages_from_js_files</b>
<i class="text-muted">(app_name=None)</i>
</p>
<div class="docs-attr-desc"><p>Extracts all translatable strings from app <code>.js</code> files</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_bench_dir" href="#frappe.translate.get_bench_dir" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_bench_dir</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.translate.get_dict" href="#frappe.translate.get_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_dict</b>
<i class="text-muted">(fortype, name=None)</i>
</p>
<div class="docs-attr-desc"><p>Returns translation dict for a type of object.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>fortype</code></strong> - must be one of <code>doctype</code>, <code>page</code>, <code>report</code>, <code>include</code>, <code>jsfile</code>, <code>boot</code></li>
<li><strong><code>name</code></strong> - name of the document for which assets are to be returned.</li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_dict_from_hooks" href="#frappe.translate.get_dict_from_hooks" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_dict_from_hooks</b>
<i class="text-muted">(fortype, 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.translate.get_full_dict" href="#frappe.translate.get_full_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_full_dict</b>
<i class="text-muted">(lang)</i>
</p>
<div class="docs-attr-desc"><p>Load and return the entire translations dictionary for a language from :meth:<code>frape.cache</code></p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>lang</code></strong> - Language Code, e.g. <code>hi</code></li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_lang_dict" href="#frappe.translate.get_lang_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_lang_dict</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p>Returns all languages in dict format, full name is the key e.g. <code>{"english":"en"}</code></p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_lang_info" href="#frappe.translate.get_lang_info" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_lang_info</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p>Returns a listified version of <code>apps/languages.txt</code></p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_lang_js" href="#frappe.translate.get_lang_js" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_lang_js</b>
<i class="text-muted">(fortype, name)</i>
</p>
<div class="docs-attr-desc"><p>Returns code snippet to be appended at the end of a JS script.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>fortype</code></strong> - Type of object, e.g. <code>DocType</code></li>
<li><strong><code>name</code></strong> - Document name</li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_language_from_code" href="#frappe.translate.get_language_from_code" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_language_from_code</b>
<i class="text-muted">(lang)</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.translate.get_messages_for_app" href="#frappe.translate.get_messages_for_app" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_messages_for_app</b>
<i class="text-muted">(app)</i>
</p>
<div class="docs-attr-desc"><p>Returns all messages (list) for a specified <code>app</code></p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_messages_from_doctype" href="#frappe.translate.get_messages_from_doctype" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_messages_from_doctype</b>
<i class="text-muted">(name)</i>
</p>
<div class="docs-attr-desc"><p>Extract all translatable messages for a doctype. Includes labels, Python code,
Javascript code, html templates</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_messages_from_file" href="#frappe.translate.get_messages_from_file" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_messages_from_file</b>
<i class="text-muted">(path)</i>
</p>
<div class="docs-attr-desc"><p>Returns a list of transatable strings from a code file</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>path</code></strong> - path of the code file</li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_messages_from_include_files" href="#frappe.translate.get_messages_from_include_files" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_messages_from_include_files</b>
<i class="text-muted">(app_name=None)</i>
</p>
<div class="docs-attr-desc"><p>Returns messages from js files included at time of boot like desk.min.js for desk and web</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_messages_from_page" href="#frappe.translate.get_messages_from_page" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_messages_from_page</b>
<i class="text-muted">(name)</i>
</p>
<div class="docs-attr-desc"><p>Returns all translatable strings from a :class:<code>frappe.core.doctype.Page</code></p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_messages_from_report" href="#frappe.translate.get_messages_from_report" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_messages_from_report</b>
<i class="text-muted">(name)</i>
</p>
<div class="docs-attr-desc"><p>Returns all translatable strings from a :class:<code>frappe.core.doctype.Report</code></p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_server_messages" href="#frappe.translate.get_server_messages" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_server_messages</b>
<i class="text-muted">(app)</i>
</p>
<div class="docs-attr-desc"><p>Extracts all translatable strings (tagged with :func:<code>frappe._</code>) from Python modules inside an app</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_untranslated" href="#frappe.translate.get_untranslated" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_untranslated</b>
<i class="text-muted">(lang, untranslated_file, get_all=False)</i>
</p>
<div class="docs-attr-desc"><p>Returns all untranslated strings for a language and writes in a file</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>lang</code></strong> - Language code.</li>
<li><strong><code>untranslated_file</code></strong> - Output file path.</li>
<li><strong><code>get_all</code></strong> - Return all strings, translated or not.</li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.get_user_lang" href="#frappe.translate.get_user_lang" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>get_user_lang</b>
<i class="text-muted">(user=None)</i>
</p>
<div class="docs-attr-desc"><p>Set frappe.local.lang from user preferences on session beginning or resumption</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.guess_language" href="#frappe.translate.guess_language" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>guess_language</b>
<i class="text-muted">(lang_list=None)</i>
</p>
<div class="docs-attr-desc"><p>Set <code>frappe.local.lang</code> from HTTP headers at beginning of request</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.is_translatable" href="#frappe.translate.is_translatable" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>is_translatable</b>
<i class="text-muted">(m)</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.translate.load_lang" href="#frappe.translate.load_lang" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>load_lang</b>
<i class="text-muted">(lang, apps=None)</i>
</p>
<div class="docs-attr-desc"><p>Combine all translations from <code>.csv</code> files in all <code>apps</code></p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.make_dict_from_messages" href="#frappe.translate.make_dict_from_messages" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>make_dict_from_messages</b>
<i class="text-muted">(messages, full_dict=None)</i>
</p>
<div class="docs-attr-desc"><p>Returns translated messages as a dict in Language specified in <code>frappe.local.lang</code></p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>messages</code></strong> - List of untranslated messages</li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.pos_to_line_no" href="#frappe.translate.pos_to_line_no" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>pos_to_line_no</b>
<i class="text-muted">(messages, code)</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.translate.read_csv_file" href="#frappe.translate.read_csv_file" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>read_csv_file</b>
<i class="text-muted">(path)</i>
</p>
<div class="docs-attr-desc"><p>Read CSV file and return as list of list</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>path</code></strong> - File path</li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.rebuild_all_translation_files" href="#frappe.translate.rebuild_all_translation_files" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>rebuild_all_translation_files</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p>Rebuild all translation files: <code>[app]/translations/[lang].csv</code>.</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.rename_language" href="#frappe.translate.rename_language" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>rename_language</b>
<i class="text-muted">(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="frappe.translate.send_translations" href="#frappe.translate.send_translations" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>send_translations</b>
<i class="text-muted">(translation_dict)</i>
</p>
<div class="docs-attr-desc"><p>Append translated dict in <code>frappe.local.response</code></p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.set_default_language" href="#frappe.translate.set_default_language" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>set_default_language</b>
<i class="text-muted">(language)</i>
</p>
<div class="docs-attr-desc"><p>Set Global default language</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.update_translations" href="#frappe.translate.update_translations" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>update_translations</b>
<i class="text-muted">(lang, untranslated_file, translated_file)</i>
</p>
<div class="docs-attr-desc"><p>Update translations from a source and target file for a given language.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>lang</code></strong> - Language code (e.g. <code>en</code>).</li>
<li><strong><code>untranslated_file</code></strong> - File path with the messages in English.</li>
<li><strong><code>translated_file</code></strong> - File path with messages in language to be updated.</li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.write_csv_file" href="#frappe.translate.write_csv_file" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>write_csv_file</b>
<i class="text-muted">(path, app_messages, lang_dict)</i>
</p>
<div class="docs-attr-desc"><p>Write translation CSV file.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>path</code></strong> - File path, usually <code>[app]/translations</code>.</li>
<li><strong><code>app_messages</code></strong> - Translatable strings for this app.</li>
<li><strong><code>lang_dict</code></strong> - Full translated dict.</li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.translate.write_translations_file" href="#frappe.translate.write_translations_file" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.translate.<b>write_translations_file</b>
<i class="text-muted">(app, lang, full_dict=None, app_messages=None)</i>
</p>
<div class="docs-attr-desc"><p>Write a translation file for a given language.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>app</code></strong> - <code>app</code> for which translations are to be written.</li>
<li><strong><code>lang</code></strong> - Language code.</li>
<li><strong><code>full_dict</code></strong> - Full translated langauge dict (optional).</li>
<li><strong><code>app_messages</code></strong> - Source strings (optional).</li>
</ul>
</div>
<br>




<!-- autodoc -->

+ 0
- 100
frappe/docs/current/api/geo/frappe.geo.country_info.html Ver arquivo

@@ -1,100 +0,0 @@
<!-- title: frappe.geo.country_info --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/geo/country_info.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.geo.country_info.get_all" href="#frappe.geo.country_info.get_all" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.geo.country_info.<b>get_all</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.geo.country_info.get_country_info" href="#frappe.geo.country_info.get_country_info" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.geo.country_info.<b>get_country_info</b>
<i class="text-muted">(country=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.geo.country_info.get_country_timezone_info</code>
</p>
<p class="docs-attr-name">
<a name="frappe.geo.country_info.get_country_timezone_info" href="#frappe.geo.country_info.get_country_timezone_info" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.geo.country_info.<b>get_country_timezone_info</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.geo.country_info.get_translated_dict" href="#frappe.geo.country_info.get_translated_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.geo.country_info.<b>get_translated_dict</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.geo.country_info.update" href="#frappe.geo.country_info.update" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.geo.country_info.<b>update</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
- 18
frappe/docs/current/api/geo/frappe.geo.html Ver arquivo

@@ -1,18 +0,0 @@
<!-- title: frappe.geo --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/geo.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>

</div>







<!-- autodoc -->

+ 0
- 19
frappe/docs/current/api/geo/index.html Ver arquivo

@@ -1,19 +0,0 @@
<!-- title: geo -->


<div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/geo"
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
- 2
frappe/docs/current/api/geo/index.txt Ver arquivo

@@ -1,2 +0,0 @@
frappe.geo.country_info
frappe.geo

+ 0
- 20
frappe/docs/current/api/index.html Ver arquivo

@@ -1,20 +0,0 @@
<!-- title: Frappe Framework API -->



<div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/frappe"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>

</div>

<h3>Contents</h3>

<!-- autodoc -->

{index}

+ 0
- 27
frappe/docs/current/api/index.txt Ver arquivo

@@ -1,27 +0,0 @@
frappe.__init__
frappe.__version__
frappe.api
frappe.app
frappe.async
frappe.auth
frappe.boot
frappe.build
frappe.celery_app
frappe.client
frappe.commands
frappe.database
frappe.defaults
frappe.exceptions
frappe.frappeclient
frappe.handler
frappe.hooks
frappe.installer
frappe.middlewares
frappe.permissions
frappe.pythonrc
frappe.sessions
frappe.setup_logging
frappe.share
frappe.tasks
frappe.test_runner
frappe.translate

+ 0
- 18
frappe/docs/current/api/integrations/frappe.integrations.html Ver arquivo

@@ -1,18 +0,0 @@
<!-- title: frappe.integrations --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/integrations.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>

</div>







<!-- autodoc -->

+ 0
- 19
frappe/docs/current/api/integrations/index.html Ver arquivo

@@ -1,19 +0,0 @@
<!-- title: integrations -->


<div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/integrations"
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
- 1
frappe/docs/current/api/integrations/index.txt Ver arquivo

@@ -1 +0,0 @@
frappe.integrations

+ 0
- 643
frappe/docs/current/api/model/frappe.model.base_document.html Ver arquivo

@@ -1,643 +0,0 @@
<!-- title: frappe.model.base_document --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/base_document.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>BaseDocument</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, d)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>

<p class="docs-attr-name">
<a name="_extract_images_from_text_editor" href="#_extract_images_from_text_editor" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>_extract_images_from_text_editor</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="_fix_numeric_types" href="#_fix_numeric_types" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>_fix_numeric_types</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_missing_mandatory_fields" href="#_get_missing_mandatory_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>_get_missing_mandatory_fields</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Get mandatory fields that do not have any values</p>
</div>
<br>

<p class="docs-attr-name">
<a name="_init_child" href="#_init_child" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>_init_child</b>
<i class="text-muted">(self, value, 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="_validate_constants" href="#_validate_constants" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>_validate_constants</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_length" href="#_validate_length" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>_validate_length</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_selects" href="#_validate_selects" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>_validate_selects</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_update_after_submit" href="#_validate_update_after_submit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>_validate_update_after_submit</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="append" href="#append" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>append</b>
<i class="text-muted">(self, key, value=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_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, no_default_fields=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="as_json" href="#as_json" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>as_json</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="cast" href="#cast" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>cast</b>
<i class="text-muted">(self, val, df)</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="db_insert" href="#db_insert" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>db_insert</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>INSERT the document (with valid columns) in the database.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="db_set" href="#db_set" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>db_set</b>
<i class="text-muted">(self, fieldname, value, update_modified=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="db_update" href="#db_update" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>db_update</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_key" href="#delete_key" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>delete_key</b>
<i class="text-muted">(self, key)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>

<p class="docs-attr-name">
<a name="extend" href="#extend" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>extend</b>
<i class="text-muted">(self, key, value)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>

<p class="docs-attr-name">
<a name="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, key=None, filters=None, limit=None, default=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_db_value" href="#get_db_value" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_db_value</b>
<i class="text-muted">(self, key)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>

<p class="docs-attr-name">
<a name="get_formatted" href="#get_formatted" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_formatted</b>
<i class="text-muted">(self, fieldname, doc=None, currency=None, absolute_value=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_invalid_links" href="#get_invalid_links" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_invalid_links</b>
<i class="text-muted">(self, is_submittable=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_parentfield_of_doctype" href="#get_parentfield_of_doctype" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_parentfield_of_doctype</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="get_table_field_doctype" href="#get_table_field_doctype" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_table_field_doctype</b>
<i class="text-muted">(self, 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="get_valid_columns" href="#get_valid_columns" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_valid_columns</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_valid_dict" href="#get_valid_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_valid_dict</b>
<i class="text-muted">(self, sanitize=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="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, 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="getone" href="#getone" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>getone</b>
<i class="text-muted">(self, key, 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="in_format_data" href="#in_format_data" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>in_format_data</b>
<i class="text-muted">(self, fieldname)</i>
</p>
<div class="docs-attr-desc"><p>Returns True if shown via Print Format::<code>format_data</code> property.
Called from within standard print format.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="init_valid_columns" href="#init_valid_columns" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>init_valid_columns</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="is_new" href="#is_new" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>is_new</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="is_print_hide" href="#is_print_hide" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>is_print_hide</b>
<i class="text-muted">(self, fieldname, df=None, for_print=True)</i>
</p>
<div class="docs-attr-desc"><p>Returns true if fieldname is to be hidden for print.</p>

<p>Print Hide can be set via the Print Format Builder or in the controller as a list
of hidden fields. Example</p>

<pre><code>class MyDoc(Document):
def __setup__(self):
self.print_hide = ["field1", "field2"]
</code></pre>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>fieldname</code></strong> - Fieldname to be checked if hidden.</li>
</ul>
</div>
<br>

<p class="docs-attr-name">
<a name="precision" href="#precision" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>precision</b>
<i class="text-muted">(self, fieldname, parentfield=None)</i>
</p>
<div class="docs-attr-desc"><p>Returns float precision for a particular field (or get global default).</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>fieldname</code></strong> - Fieldname for which precision is required.</li>
<li><strong><code>parentfield</code></strong> - If fieldname is in child table.</li>
</ul>
</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, 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="reset_values_if_no_permlevel_access" href="#reset_values_if_no_permlevel_access" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>reset_values_if_no_permlevel_access</b>
<i class="text-muted">(self, has_access_to, high_permlevel_fields)</i>
</p>
<div class="docs-attr-desc"><p>If the user does not have permissions at permlevel &gt; 0, then reset the values to original / default</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, key, value, as_value=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="show_unique_validation_message" href="#show_unique_validation_message" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>show_unique_validation_message</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="update" href="#update" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update</b>
<i class="text-muted">(self, d)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>

<p class="docs-attr-name">
<a name="update_if_missing" href="#update_if_missing" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_if_missing</b>
<i class="text-muted">(self, d)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>

</div>
<hr>


<p class="docs-attr-name">
<a name="frappe.model.base_document._filter" href="#frappe.model.base_document._filter" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.base_document.<b>_filter</b>
<i class="text-muted">(data, filters, limit=None)</i>
</p>
<div class="docs-attr-desc"><p>pass filters as:
{"key": "val", "key": ["!=", "val"],
"key": ["in", "val"], "key": ["not in", "val"], "key": "^val",
"key" : True (exists), "key": False (does not exist) }</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.base_document.get_controller" href="#frappe.model.base_document.get_controller" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.base_document.<b>get_controller</b>
<i class="text-muted">(doctype)</i>
</p>
<div class="docs-attr-desc"><p>Returns the <strong>class</strong> object of the given DocType.
For <code>custom</code> type, returns <code>frappe.model.document.Document</code>.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>doctype</code></strong> - DocType name as string.</li>
</ul>
</div>
<br>




<!-- autodoc -->

+ 0
- 146
frappe/docs/current/api/model/frappe.model.create_new.html Ver arquivo

@@ -1,146 +0,0 @@
<!-- title: frappe.model.create_new --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/create_new.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.model.create_new.get_default_based_on_another_field" href="#frappe.model.create_new.get_default_based_on_another_field" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.create_new.<b>get_default_based_on_another_field</b>
<i class="text-muted">(df, user_permissions, parent_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.model.create_new.get_new_doc" href="#frappe.model.create_new.get_new_doc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.create_new.<b>get_new_doc</b>
<i class="text-muted">(doctype, parent_doc=None, parentfield=None, as_dict=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.model.create_new.get_static_default_value" href="#frappe.model.create_new.get_static_default_value" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.create_new.<b>get_static_default_value</b>
<i class="text-muted">(df, user_permissions)</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.model.create_new.get_user_default_value" href="#frappe.model.create_new.get_user_default_value" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.create_new.<b>get_user_default_value</b>
<i class="text-muted">(df, defaults, user_permissions)</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.model.create_new.make_new_doc" href="#frappe.model.create_new.make_new_doc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.create_new.<b>make_new_doc</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.model.create_new.set_dynamic_default_values" href="#frappe.model.create_new.set_dynamic_default_values" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.create_new.<b>set_dynamic_default_values</b>
<i class="text-muted">(doc, parent_doc, parentfield)</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.model.create_new.set_user_and_static_default_values" href="#frappe.model.create_new.set_user_and_static_default_values" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.create_new.<b>set_user_and_static_default_values</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.model.create_new.user_permissions_exist" href="#frappe.model.create_new.user_permissions_exist" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.create_new.<b>user_permissions_exist</b>
<i class="text-muted">(df, user_permissions)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>




<!-- autodoc -->

+ 0
- 350
frappe/docs/current/api/model/frappe.model.db_query.html Ver arquivo

@@ -1,350 +0,0 @@
<!-- title: frappe.model.db_query --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/db_query.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>DatabaseQuery</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, 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_comment_count" href="#add_comment_count" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>add_comment_count</b>
<i class="text-muted">(self, result)</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_limit" href="#add_limit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>add_limit</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_user_permissions" href="#add_user_permissions" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>add_user_permissions</b>
<i class="text-muted">(self, user_permissions, user_permission_doctypes=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="append_table" href="#append_table" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>append_table</b>
<i class="text-muted">(self, table_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="build_and_run" href="#build_and_run" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>build_and_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>

<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)</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_filter_conditions" href="#build_filter_conditions" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>build_filter_conditions</b>
<i class="text-muted">(self, filters, conditions)</i>
</p>
<div class="docs-attr-desc"><p>build conditions from user filters</p>
</div>
<br>

<p class="docs-attr-name">
<a name="build_match_conditions" href="#build_match_conditions" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>build_match_conditions</b>
<i class="text-muted">(self, as_condition=True)</i>
</p>
<div class="docs-attr-desc"><p>add match conditions if applicable</p>
</div>
<br>

<p class="docs-attr-name">
<a name="check_sort_by_table" href="#check_sort_by_table" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_sort_by_table</b>
<i class="text-muted">(self, order_by)</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="execute" href="#execute" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>execute</b>
<i class="text-muted">(self, query=None, fields=None, filters=None, or_filters=None, docstatus=None, group_by=None, order_by=None, limit_start=False, limit_page_length=None, as_list=False, with_childnames=False, debug=False, ignore_permissions=False, user=None, with_comment_count=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="extract_tables" href="#extract_tables" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>extract_tables</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>extract tables from fields</p>
</div>
<br>

<p class="docs-attr-name">
<a name="get_filter" href="#get_filter" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_filter</b>
<i class="text-muted">(self, f)</i>
</p>
<div class="docs-attr-desc"><p>Returns a _dict like</p>

<p>{
"doctype": "DocType",
"fieldname": "fieldname",
"operator": "=",
"value": "value"
}</p>
</div>
<br>

<p class="docs-attr-name">
<a name="get_permission_query_conditions" href="#get_permission_query_conditions" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_permission_query_conditions</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_share_condition" href="#get_share_condition" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_share_condition</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_filter_tuple" href="#make_filter_tuple" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>make_filter_tuple</b>
<i class="text-muted">(self, key, value)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>

<p class="docs-attr-name">
<a name="parse_args" href="#parse_args" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>parse_args</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Convert fields and filters from strings to list, dicts</p>
</div>
<br>

<p class="docs-attr-name">
<a name="prepare_args" href="#prepare_args" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>prepare_args</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="prepare_filter_condition" href="#prepare_filter_condition" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>prepare_filter_condition</b>
<i class="text-muted">(self, f)</i>
</p>
<div class="docs-attr-desc"><p>Returns a filter condition in the format:</p>

<p>ifnull(<code>tabDocType</code>.<code>fieldname</code>, fallback) operator "value"</p>
</div>
<br>

<p class="docs-attr-name">
<a name="remove_user_tags" href="#remove_user_tags" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>remove_user_tags</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Removes optional columns like <code>_user_tags</code>, <code>_comments</code> etc. if not in table</p>
</div>
<br>

<p class="docs-attr-name">
<a name="run_custom_query" href="#run_custom_query" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>run_custom_query</b>
<i class="text-muted">(self, query)</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_order_by" href="#set_order_by" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>set_order_by</b>
<i class="text-muted">(self, args)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>

</div>
<hr>




<!-- autodoc -->

+ 0
- 597
frappe/docs/current/api/model/frappe.model.db_schema.html Ver arquivo

@@ -1,597 +0,0 @@
<!-- title: frappe.model.db_schema --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/db_schema.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>DbColumn</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, table, fieldname, fieldtype, length, default, set_index, options, unique, precision)</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_for_alter_table" href="#build_for_alter_table" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>build_for_alter_table</b>
<i class="text-muted">(self, current_def)</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="default_changed" href="#default_changed" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>default_changed</b>
<i class="text-muted">(self, current_def)</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="default_changed_for_decimal" href="#default_changed_for_decimal" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>default_changed_for_decimal</b>
<i class="text-muted">(self, current_def)</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_definition" href="#get_definition" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_definition</b>
<i class="text-muted">(self, with_default=1)</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>DbManager</b></h3>
<div class="docs-attr-desc"><p>Basically, a wrapper for oft-used mysql commands. like show tables,databases, variables etc...</p>

<h1>TODO:</h1>

<pre><code>0. Simplify / create settings for the restore database source folder
0a. Merge restore database and extract_sql(from frappe_server_tools).
1. Setter and getter for different mysql variables.
2. Setter and getter for mysql variables at global level??
</code></pre>
</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, db)</i>
</p>
<div class="docs-attr-desc"><p>Pass root_conn here for access to all databases.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="create_database" href="#create_database" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>create_database</b>
<i class="text-muted">(self, target)</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="create_user" href="#create_user" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>create_user</b>
<i class="text-muted">(self, user, password, host)</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_user" href="#delete_user" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>delete_user</b>
<i class="text-muted">(self, target, host)</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="drop_database" href="#drop_database" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>drop_database</b>
<i class="text-muted">(self, target)</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="drop_table" href="#drop_table" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>drop_table</b>
<i class="text-muted">(self, table_name)</i>
</p>
<div class="docs-attr-desc"><p>drop table if exists</p>
</div>
<br>

<p class="docs-attr-name">
<a name="flush_privileges" href="#flush_privileges" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>flush_privileges</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_database_list" href="#get_database_list" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_database_list</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>get list of databases</p>
</div>
<br>

<p class="docs-attr-name">
<a name="get_table_schema" href="#get_table_schema" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_table_schema</b>
<i class="text-muted">(self, table)</i>
</p>
<div class="docs-attr-desc"><p>Just returns the output of Desc tables.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="get_tables_list" href="#get_tables_list" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_tables_list</b>
<i class="text-muted">(self, target=None)</i>
</p>
<div class="docs-attr-desc"><p>get list of tables</p>
</div>
<br>

<p class="docs-attr-name">
<a name="get_variables" href="#get_variables" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_variables</b>
<i class="text-muted">(self, regex)</i>
</p>
<div class="docs-attr-desc"><p>Get variables that match the passed pattern regex</p>
</div>
<br>

<p class="docs-attr-name">
<a name="grant_all_privileges" href="#grant_all_privileges" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>grant_all_privileges</b>
<i class="text-muted">(self, target, user, host)</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="grant_select_privilges" href="#grant_select_privilges" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>grant_select_privilges</b>
<i class="text-muted">(self, db, table, user, host)</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="restore_database" href="#restore_database" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>restore_database</b>
<i class="text-muted">(self, target, source, user, password)</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>DbTable</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, doctype, prefix=tab)</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="alter" href="#alter" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>alter</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="create" href="#create" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>create</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="drop_foreign_keys" href="#drop_foreign_keys" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>drop_foreign_keys</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_column_definitions" href="#get_column_definitions" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_column_definitions</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_columns_from_db" href="#get_columns_from_db" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_columns_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_columns_from_docfields" href="#get_columns_from_docfields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_columns_from_docfields</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>get columns from docfields and custom fields</p>
</div>
<br>

<p class="docs-attr-name">
<a name="get_foreign_keys" href="#get_foreign_keys" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_foreign_keys</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_index_definitions" href="#get_index_definitions" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_index_definitions</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="is_new" href="#is_new" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>is_new</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="sync" href="#sync" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>sync</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" 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>Check if change in varchar length isn't truncating the columns</p>
</div>
<br>

</div>
<hr>


<h3 style="font-weight: normal;">Class <b>InvalidColumnName</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.model.db_schema.add_column" href="#frappe.model.db_schema.add_column" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.db_schema.<b>add_column</b>
<i class="text-muted">(doctype, column_name, fieldtype, precision=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.model.db_schema.get_definition" href="#frappe.model.db_schema.get_definition" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.db_schema.<b>get_definition</b>
<i class="text-muted">(fieldtype, precision=None, length=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.model.db_schema.remove_all_foreign_keys" href="#frappe.model.db_schema.remove_all_foreign_keys" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.db_schema.<b>remove_all_foreign_keys</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.model.db_schema.updatedb" href="#frappe.model.db_schema.updatedb" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.db_schema.<b>updatedb</b>
<i class="text-muted">(dt)</i>
</p>
<div class="docs-attr-desc"><p>Syncs a <code>DocType</code> to the table
* creates if required
* updates columns
* updates indices</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.db_schema.validate_column_name" href="#frappe.model.db_schema.validate_column_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.db_schema.<b>validate_column_name</b>
<i class="text-muted">(n)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>




<!-- autodoc -->

+ 0
- 194
frappe/docs/current/api/model/frappe.model.delete_doc.html Ver arquivo

@@ -1,194 +0,0 @@
<!-- title: frappe.model.delete_doc --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/delete_doc.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.model.delete_doc.check_if_doc_is_dynamically_linked" href="#frappe.model.delete_doc.check_if_doc_is_dynamically_linked" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.delete_doc.<b>check_if_doc_is_dynamically_linked</b>
<i class="text-muted">(doc, method=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="frappe.model.delete_doc.check_if_doc_is_linked" href="#frappe.model.delete_doc.check_if_doc_is_linked" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.delete_doc.<b>check_if_doc_is_linked</b>
<i class="text-muted">(doc, method=Delete)</i>
</p>
<div class="docs-attr-desc"><p>Raises excption if the given doc(dt, dn) is linked in another record.</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.delete_doc.check_permission_and_not_submitted" href="#frappe.model.delete_doc.check_permission_and_not_submitted" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.delete_doc.<b>check_permission_and_not_submitted</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.model.delete_doc.delete_doc" href="#frappe.model.delete_doc.delete_doc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.delete_doc.<b>delete_doc</b>
<i class="text-muted">(doctype=None, name=None, force=0, ignore_doctypes=None, for_reload=False, ignore_permissions=False, flags=None, ignore_on_trash=False)</i>
</p>
<div class="docs-attr-desc"><p>Deletes a doc(dt, dn) and validates if it is not submitted and not linked in a live record</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.delete_doc.delete_from_table" href="#frappe.model.delete_doc.delete_from_table" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.delete_doc.<b>delete_from_table</b>
<i class="text-muted">(doctype, name, ignore_doctypes, 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.model.delete_doc.delete_linked_comments" href="#frappe.model.delete_doc.delete_linked_comments" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.delete_doc.<b>delete_linked_comments</b>
<i class="text-muted">(doc)</i>
</p>
<div class="docs-attr-desc"><p>Delete comments from the document</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.delete_doc.delete_linked_communications" href="#frappe.model.delete_doc.delete_linked_communications" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.delete_doc.<b>delete_linked_communications</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.model.delete_doc.delete_linked_todos" href="#frappe.model.delete_doc.delete_linked_todos" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.delete_doc.<b>delete_linked_todos</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.model.delete_doc.delete_shared" href="#frappe.model.delete_doc.delete_shared" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.delete_doc.<b>delete_shared</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.model.delete_doc.insert_feed" href="#frappe.model.delete_doc.insert_feed" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.delete_doc.<b>insert_feed</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.model.delete_doc.update_naming_series" href="#frappe.model.delete_doc.update_naming_series" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.delete_doc.<b>update_naming_series</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
- 98
frappe/docs/current/api/model/frappe.model.docfield.html Ver arquivo

@@ -1,98 +0,0 @@
<!-- title: frappe.model.docfield --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/docfield.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.model.docfield.get_change_column_query" href="#frappe.model.docfield.get_change_column_query" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.docfield.<b>get_change_column_query</b>
<i class="text-muted">(f, new)</i>
</p>
<div class="docs-attr-desc"><p>generate change fieldname query</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.docfield.rename" href="#frappe.model.docfield.rename" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.docfield.<b>rename</b>
<i class="text-muted">(doctype, fieldname, newname)</i>
</p>
<div class="docs-attr-desc"><p>rename docfield</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.docfield.update_parent_field" href="#frappe.model.docfield.update_parent_field" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.docfield.<b>update_parent_field</b>
<i class="text-muted">(f, new)</i>
</p>
<div class="docs-attr-desc"><p>update 'parentfield' in tables</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.docfield.update_single" href="#frappe.model.docfield.update_single" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.docfield.<b>update_single</b>
<i class="text-muted">(f, new)</i>
</p>
<div class="docs-attr-desc"><p>update in tabSingles</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.docfield.update_table" href="#frappe.model.docfield.update_table" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.docfield.<b>update_table</b>
<i class="text-muted">(f, new)</i>
</p>
<div class="docs-attr-desc"><p>update table</p>
</div>
<br>




<!-- autodoc -->

+ 0
- 788
frappe/docs/current/api/model/frappe.model.document.html Ver arquivo

@@ -1,788 +0,0 @@
<!-- title: frappe.model.document --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/document.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>Document</b></h3>
<p style="padding-left: 30px;"><i>Inherits from frappe.model.base_document.BaseDocument</i></h4>
<div class="docs-attr-desc"><p>All controllers inherit from <code>Document</code>.</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, arg1, arg2=None)</i>
</p>
<div class="docs-attr-desc"><p>Constructor.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>arg1</code></strong> - DocType name as string or document <strong>dict</strong></li>
<li><strong><code>arg2</code></strong> - Document name, if <code>arg1</code> is DocType name.</li>
</ul>

<p>If DocType name and document name are passed, the object will load
all values (including child documents) from the database.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="_set_defaults" href="#_set_defaults" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>_set_defaults</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" 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><span class="text-muted">No docs</span></p>
</div>
<br>

<p class="docs-attr-name">
<a name="_validate_links" href="#_validate_links" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>_validate_links</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_mandatory" href="#_validate_mandatory" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>_validate_mandatory</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_comment" href="#add_comment" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>add_comment</b>
<i class="text-muted">(self, comment_type, text=None, comment_by=None, reference_doctype=None, reference_name=None)</i>
</p>
<div class="docs-attr-desc"><p>Add a comment to this document.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>comment_type</code></strong> - e.g. <code>Comment</code>. See Comment for more info.</li>
</ul>
</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)</i>
</p>
<div class="docs-attr-desc"><p>Cancel the document. Sets <code>docstatus</code> = 2, then saves.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="check_docstatus_transition" href="#check_docstatus_transition" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_docstatus_transition</b>
<i class="text-muted">(self, docstatus)</i>
</p>
<div class="docs-attr-desc"><p>Ensures valid <code>docstatus</code> transition.
Valid transitions are (number in brackets is <code>docstatus</code>):</p>

<ul>
<li>Save (0) &gt; Save (0)</li>
<li>Save (0) &gt; Submit (1)</li>
<li>Submit (1) &gt; Submit (1)</li>
<li>Submit (1) &gt; Cancel (2)</li>
</ul>
</div>
<br>

<p class="docs-attr-name">
<a name="check_if_latest" href="#check_if_latest" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_if_latest</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Checks if <code>modified</code> timestamp provided by document being updated is same as the
<code>modified</code> timestamp in the database. If there is a different, the document has been
updated in the database after the current copy was read. Will throw an error if
timestamps don't match.</p>

<p>Will also validate document transitions (Save &gt; Submit &gt; Cancel) calling
<code>self.check_docstatus_transition</code>.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="check_no_back_links_exist" href="#check_no_back_links_exist" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_no_back_links_exist</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Check if document links to any active document before Cancel.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="check_permission" href="#check_permission" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_permission</b>
<i class="text-muted">(self, permtype, permlabel=None)</i>
</p>
<div class="docs-attr-desc"><p>Raise <code>frappe.PermissionError</code> if not permitted</p>
</div>
<br>

<p class="docs-attr-name">
<a name="clear_cache" href="#clear_cache" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>clear_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="clear_linked_with_cache" href="#clear_linked_with_cache" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>clear_linked_with_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="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)</i>
</p>
<div class="docs-attr-desc"><p>Delete document.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="get_all_children" href="#get_all_children" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_all_children</b>
<i class="text-muted">(self, parenttype=None)</i>
</p>
<div class="docs-attr-desc"><p>Returns all children documents from <strong>Table</strong> type field in a list.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="get_latest" href="#get_latest" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_latest</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_liked_by" href="#get_liked_by" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_liked_by</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_permlevel_access" href="#get_permlevel_access" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_permlevel_access</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_signature" href="#get_signature" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_signature</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Returns signature (hash) for private URL.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="get_url" href="#get_url" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_url</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Returns Desk URL for this document. <code>/desk#Form/{doctype}/{name}</code></p>
</div>
<br>

<p class="docs-attr-name">
<a name="has_permission" href="#has_permission" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>has_permission</b>
<i class="text-muted">(self, permtype=read, verbose=False)</i>
</p>
<div class="docs-attr-desc"><p>Call <code>frappe.has_permission</code> if <code>self.flags.ignore_permissions</code>
is not set.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>permtype</code></strong> - one of <code>read</code>, <code>write</code>, <code>submit</code>, <code>cancel</code>, <code>delete</code></li>
</ul>
</div>
<br>

<p class="docs-attr-name">
<a name="has_website_permission" href="#has_website_permission" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>has_website_permission</b>
<i class="text-muted">(self, permtype=read, verbose=False)</i>
</p>
<div class="docs-attr-desc"><p>Call <code>frappe.has_website_permission</code> if <code>self.flags.ignore_permissions</code>
is not set.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>permtype</code></strong> - one of <code>read</code>, <code>write</code>, <code>submit</code>, <code>cancel</code>, <code>delete</code></li>
</ul>
</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, ignore_permissions=None)</i>
</p>
<div class="docs-attr-desc"><p>Insert the document in the database (as a new document).
This will check for user permissions and execute <code>before_insert</code>,
<code>validate</code>, <code>on_update</code>, <code>after_insert</code> methods if they are written.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>ignore_permissions</code></strong> - Do not check permissions if True.</li>
</ul>
</div>
<br>

<p class="docs-attr-name">
<a name="is_whitelisted" href="#is_whitelisted" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>is_whitelisted</b>
<i class="text-muted">(self, method)</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_from_db" href="#load_from_db" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>load_from_db</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Load document and children from database and create properties
from fields</p>
</div>
<br>

<p class="docs-attr-name">
<a name="notify_update" href="#notify_update" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>notify_update</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Publish realtime that the current document is modified</p>
</div>
<br>

<p class="docs-attr-name">
<a name="raise_no_permission_to" href="#raise_no_permission_to" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>raise_no_permission_to</b>
<i class="text-muted">(self, perm_type)</i>
</p>
<div class="docs-attr-desc"><p>Raise <code>frappe.PermissionError</code>.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="reload" href="#reload" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>reload</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Reload document from database</p>
</div>
<br>

<p class="docs-attr-name">
<a name="round_floats_in" href="#round_floats_in" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>round_floats_in</b>
<i class="text-muted">(self, doc, fieldnames=None)</i>
</p>
<div class="docs-attr-desc"><p>Round floats for all <code>Currency</code>, <code>Float</code>, <code>Percent</code> fields for the given doc.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>doc</code></strong> - Document whose numeric properties are to be rounded.</li>
<li><strong><code>fieldnames</code></strong> - [Optional] List of fields to be rounded.</li>
</ul>
</div>
<br>

<p class="docs-attr-name">
<a name="run_before_save_methods" href="#run_before_save_methods" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>run_before_save_methods</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Run standard methods before <code>INSERT</code> or <code>UPDATE</code>. Standard Methods are:</p>

<ul>
<li><code>validate</code>, <code>before_save</code> for <strong>Save</strong>.</li>
<li><code>validate</code>, <code>before_submit</code> for <strong>Submit</strong>.</li>
<li><code>before_cancel</code> for <strong>Cancel</strong></li>
<li><code>before_update_after_submit</code> for <strong>Update after Submit</strong></li>
</ul>

<p>Will also update title_field if set</p>
</div>
<br>

<p class="docs-attr-name">
<a name="run_method" href="#run_method" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>run_method</b>
<i class="text-muted">(self, method)</i>
</p>
<div class="docs-attr-desc"><p>run standard triggers, plus those in hooks</p>
</div>
<br>

<p class="docs-attr-name">
<a name="run_post_save_methods" href="#run_post_save_methods" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>run_post_save_methods</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Run standard methods after <code>INSERT</code> or <code>UPDATE</code>. Standard Methods are:</p>

<ul>
<li><code>on_update</code> for <strong>Save</strong>.</li>
<li><code>on_update</code>, <code>on_submit</code> for <strong>Submit</strong>.</li>
<li><code>on_cancel</code> for <strong>Cancel</strong></li>
<li><code>update_after_submit</code> for <strong>Update after Submit</strong></li>
</ul>
</div>
<br>

<p class="docs-attr-name">
<a name="save" href="#save" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>save</b>
<i class="text-muted">(self, ignore_permissions=None)</i>
</p>
<div class="docs-attr-desc"><p>Save the current document in the database in the <strong>DocType</strong>'s table or
<code>tabSingles</code> (for single types).</p>

<p>This will check for user permissions and execute
<code>validate</code> before updating, <code>on_update</code> after updating triggers.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>ignore_permissions</code></strong> - Do not check permissions if True.</li>
</ul>
</div>
<br>

<p class="docs-attr-name">
<a name="set_docstatus_user_and_timestamp" href="#set_docstatus_user_and_timestamp" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>set_docstatus_user_and_timestamp</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_new_name" href="#set_new_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>set_new_name</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Calls <code>frappe.naming.se_new_name</code> for parent and child docs.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="set_onload" href="#set_onload" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>set_onload</b>
<i class="text-muted">(self, key, value)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>

<p class="docs-attr-name">
<a name="set_parent_in_children" href="#set_parent_in_children" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>set_parent_in_children</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Updates <code>parent</code> and <code>parenttype</code> property in all children.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="set_title_field" href="#set_title_field" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>set_title_field</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Set title field based on template</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)</i>
</p>
<div class="docs-attr-desc"><p>Submit the document. Sets <code>docstatus</code> = 1, then saves.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="update_children" href="#update_children" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_children</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>

<p class="docs-attr-name">
<a name="update_single" href="#update_single" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_single</b>
<i class="text-muted">(self, d)</i>
</p>
<div class="docs-attr-desc"><p>Updates values for Single type Document in <code>tabSingles</code>.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="validate_higher_perm_levels" href="#validate_higher_perm_levels" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_higher_perm_levels</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>If the user does not have permissions at permlevel &gt; 0, then reset the values to original / default</p>
</div>
<br>

<p class="docs-attr-name">
<a name="validate_table_has_rows" href="#validate_table_has_rows" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_table_has_rows</b>
<i class="text-muted">(self, parentfield, raise_exception=None)</i>
</p>
<div class="docs-attr-desc"><p>Raise exception if Table field is empty.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="validate_update_after_submit" href="#validate_update_after_submit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_update_after_submit</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_value" href="#validate_value" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_value</b>
<i class="text-muted">(self, fieldname, condition, val2, doc=None, raise_exception=None)</i>
</p>
<div class="docs-attr-desc"><p>Check that value of fieldname should be 'condition' val2
else throw Exception.</p>
</div>
<br>

</div>
<hr>


<p class="docs-attr-name">
<a name="frappe.model.document.get_doc" href="#frappe.model.document.get_doc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.document.<b>get_doc</b>
<i class="text-muted">(arg1, arg2=None)</i>
</p>
<div class="docs-attr-desc"><p>returns a frappe.model.Document object.</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>arg1</code></strong> - Document dict or DocType name.</li>
<li><strong><code>arg2</code></strong> - [optional] document name.</li>
</ul>

<p>There are two ways to call <code>get_doc</code></p>

<pre><code># will fetch the latest user object (with child table) from the database
user = get_doc("User", "test@example.com")

# create a new object
user = get_doc({
"doctype":"User"
"email_id": "test@example.com",
"user_roles: [
{"role": "System Manager"}
]
})
</code></pre>
</div>
<br>




<!-- autodoc -->

+ 0
- 87
frappe/docs/current/api/model/frappe.model.html Ver arquivo

@@ -1,87 +0,0 @@
<!-- title: frappe.model --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model.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.model.copytables" href="#frappe.model.copytables" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.<b>copytables</b>
<i class="text-muted">(srctype, src, srcfield, tartype, tar, tarfield, srcfields, tarfields=[])</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.model.db_exists" href="#frappe.model.db_exists" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.<b>db_exists</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.model.delete_fields" href="#frappe.model.delete_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.<b>delete_fields</b>
<i class="text-muted">(args_dict, delete=0)</i>
</p>
<div class="docs-attr-desc"><p>Delete a field.
* Deletes record from <code>tabDocField</code>
* If not single doctype: Drops column from table
* If single, deletes record from <code>tabSingles</code></p>

<p>args_dict = { dt: [field names] }</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.rename" href="#frappe.model.rename" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.<b>rename</b>
<i class="text-muted">(doctype, old, new, debug=False)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>




<!-- autodoc -->

+ 0
- 98
frappe/docs/current/api/model/frappe.model.mapper.html Ver arquivo

@@ -1,98 +0,0 @@
<!-- title: frappe.model.mapper --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/mapper.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.model.mapper.get_mapped_doc" href="#frappe.model.mapper.get_mapped_doc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.mapper.<b>get_mapped_doc</b>
<i class="text-muted">(from_doctype, from_docname, table_maps, target_doc=None, postprocess=None, ignore_permissions=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.model.mapper.map_child_doc" href="#frappe.model.mapper.map_child_doc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.mapper.<b>map_child_doc</b>
<i class="text-muted">(source_d, target_parent, table_map, source_parent=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.model.mapper.map_doc" href="#frappe.model.mapper.map_doc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.mapper.<b>map_doc</b>
<i class="text-muted">(source_doc, target_doc, table_map, source_parent=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.model.mapper.map_fetch_fields" href="#frappe.model.mapper.map_fetch_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.mapper.<b>map_fetch_fields</b>
<i class="text-muted">(target_doc, df, no_copy_fields)</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.model.mapper.map_fields" href="#frappe.model.mapper.map_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.mapper.<b>map_fields</b>
<i class="text-muted">(source_doc, target_doc, table_map, source_parent)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>




<!-- autodoc -->

+ 0
- 489
frappe/docs/current/api/model/frappe.model.meta.html Ver arquivo

@@ -1,489 +0,0 @@
<!-- title: frappe.model.meta --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/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>Meta</b></h3>
<p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</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_custom_fields" href="#add_custom_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>add_custom_fields</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="apply_property_setters" href="#apply_property_setters" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>apply_property_setters</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_dynamic_link_fields" href="#get_dynamic_link_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_dynamic_link_fields</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_field" href="#get_field" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_field</b>
<i class="text-muted">(self, 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="get_fields_to_check_permissions" href="#get_fields_to_check_permissions" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_fields_to_check_permissions</b>
<i class="text-muted">(self, user_permission_doctypes)</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_high_permlevel_fields" href="#get_high_permlevel_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_high_permlevel_fields</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Build list of fields with high perm level and all the higher perm levels defined.</p>
</div>
<br>

<p class="docs-attr-name">
<a name="get_label" href="#get_label" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_label</b>
<i class="text-muted">(self, 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="get_link_fields" href="#get_link_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_link_fields</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_list_fields" href="#get_list_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_list_fields</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_options" href="#get_options" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_options</b>
<i class="text-muted">(self, 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="get_search_fields" href="#get_search_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_search_fields</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_select_fields" href="#get_select_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_select_fields</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_table_field_doctype" href="#get_table_field_doctype" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_table_field_doctype</b>
<i class="text-muted">(self, 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="get_table_fields" href="#get_table_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_table_fields</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_title_field" href="#get_title_field" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_title_field</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_valid_columns" href="#get_valid_columns" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_valid_columns</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_from_db" href="#load_from_db" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>load_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="process" href="#process" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>process</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="sort_fields" href="#sort_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>sort_fields</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>sort on basis of previous_field</p>
</div>
<br>

</div>
<hr>


<p class="docs-attr-name">
<a name="frappe.model.meta.clear_cache" href="#frappe.model.meta.clear_cache" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.meta.<b>clear_cache</b>
<i class="text-muted">(doctype=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.model.meta.get_default_df" href="#frappe.model.meta.get_default_df" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.meta.<b>get_default_df</b>
<i class="text-muted">(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="frappe.model.meta.get_field_currency" href="#frappe.model.meta.get_field_currency" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.meta.<b>get_field_currency</b>
<i class="text-muted">(df, doc=None)</i>
</p>
<div class="docs-attr-desc"><p>get currency based on DocField options and fieldvalue in doc</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.meta.get_field_precision" href="#frappe.model.meta.get_field_precision" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.meta.<b>get_field_precision</b>
<i class="text-muted">(df, doc=None, currency=None)</i>
</p>
<div class="docs-attr-desc"><p>get precision based on DocField options and fieldvalue in doc</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.meta.get_meta" href="#frappe.model.meta.get_meta" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.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>


<p class="docs-attr-name">
<a name="frappe.model.meta.get_parent_dt" href="#frappe.model.meta.get_parent_dt" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.meta.<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.model.meta.get_table_columns" href="#frappe.model.meta.get_table_columns" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.meta.<b>get_table_columns</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.model.meta.is_single" href="#frappe.model.meta.is_single" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.meta.<b>is_single</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.model.meta.load_doctype_from_file" href="#frappe.model.meta.load_doctype_from_file" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.meta.<b>load_doctype_from_file</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.model.meta.set_fieldname" href="#frappe.model.meta.set_fieldname" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.meta.<b>set_fieldname</b>
<i class="text-muted">(field_id, 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="frappe.model.meta.trim_tables" href="#frappe.model.meta.trim_tables" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.meta.<b>trim_tables</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p>Use this to remove columns that don't exist in meta</p>
</div>
<br>




<!-- autodoc -->

+ 0
- 209
frappe/docs/current/api/model/frappe.model.naming.html Ver arquivo

@@ -1,209 +0,0 @@
<!-- title: frappe.model.naming --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/naming.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.model.naming._set_amended_name" href="#frappe.model.naming._set_amended_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>_set_amended_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>


<p class="docs-attr-name">
<a name="frappe.model.naming.append_number_if_name_exists" href="#frappe.model.naming.append_number_if_name_exists" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>append_number_if_name_exists</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.model.naming.de_duplicate" href="#frappe.model.naming.de_duplicate" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>de_duplicate</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.model.naming.get_default_naming_series" href="#frappe.model.naming.get_default_naming_series" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>get_default_naming_series</b>
<i class="text-muted">(doctype)</i>
</p>
<div class="docs-attr-desc"><p>get default value for <code>naming_series</code> property</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.naming.getseries" href="#frappe.model.naming.getseries" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>getseries</b>
<i class="text-muted">(key, digits, 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.model.naming.make_autoname" href="#frappe.model.naming.make_autoname" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>make_autoname</b>
<i class="text-muted">(key, doctype=)</i>
</p>
<div class="docs-attr-desc"><p>Creates an autoname from the given key:</p>

<p><strong>Autoname rules:</strong></p>

<pre><code> * The key is separated by '.'
* '####' represents a series. The string before this part becomes the prefix:
Example: ABC.#### creates a series ABC0001, ABC0002 etc
* 'MM' represents the current month
* 'YY' and 'YYYY' represent the current year
</code></pre>

<p><em>Example:</em></p>

<pre><code> * DE/./.YY./.MM./.##### will create a series like
DE/09/01/0001 where 09 is the year, 01 is the month and 0001 is the series
</code></pre>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.naming.revert_series_if_last" href="#frappe.model.naming.revert_series_if_last" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>revert_series_if_last</b>
<i class="text-muted">(key, 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.model.naming.set_name_by_naming_series" href="#frappe.model.naming.set_name_by_naming_series" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>set_name_by_naming_series</b>
<i class="text-muted">(doc)</i>
</p>
<div class="docs-attr-desc"><p>Sets name by the <code>naming_series</code> property</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.naming.set_new_name" href="#frappe.model.naming.set_new_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>set_new_name</b>
<i class="text-muted">(doc)</i>
</p>
<div class="docs-attr-desc"><p>Sets the `name`` property for the document based on various rules.</p>

<ol>
<li>If amened doc, set suffix.</li>
<li>If <code>autoname</code> method is declared, then call it.</li>
<li>If <code>autoname</code> property is set in the DocType (<code>meta</code>), then build it using the <code>autoname</code> property.</li>
<li>If <code>name</code> is already defined, use that name</li>
<li>If no rule defined, use hash.</li>
</ol>

<h4>Note:</h4>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>doc</code></strong> - Document to be named.</li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.naming.validate_name" href="#frappe.model.naming.validate_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>validate_name</b>
<i class="text-muted">(doctype, name, case=None, merge=False)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>




<!-- autodoc -->

+ 0
- 285
frappe/docs/current/api/model/frappe.model.rename_doc.html Ver arquivo

@@ -1,285 +0,0 @@
<!-- title: frappe.model.rename_doc --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/rename_doc.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.model.rename_doc.bulk_rename" href="#frappe.model.rename_doc.bulk_rename" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>bulk_rename</b>
<i class="text-muted">(doctype, rows=None, via_console=False)</i>
</p>
<div class="docs-attr-desc"><p>Bulk rename documents</p>

<p><strong>Parameters:</strong></p>

<ul>
<li><strong><code>doctype</code></strong> - DocType to be renamed</li>
<li><strong><code>rows</code></strong> - list of documents as <code>((oldname, newname), ..)</code></li>
</ul>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.rename_doc.get_link_fields" href="#frappe.model.rename_doc.get_link_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>get_link_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 class="docs-attr-name">
<a name="frappe.model.rename_doc.get_select_fields" href="#frappe.model.rename_doc.get_select_fields" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>get_select_fields</b>
<i class="text-muted">(old, new)</i>
</p>
<div class="docs-attr-desc"><p>get select type fields where doctype's name is hardcoded as
new line separated list</p>
</div>
<br>


<p><span class="label label-info">Public API</span>
<br><code>/api/method/frappe.model.rename_doc.rename_doc</code>
</p>
<p class="docs-attr-name">
<a name="frappe.model.rename_doc.rename_doc" href="#frappe.model.rename_doc.rename_doc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>rename_doc</b>
<i class="text-muted">(doctype, old, new, force=False, merge=False, ignore_permissions=False)</i>
</p>
<div class="docs-attr-desc"><p>Renames a doc(dt, old) to doc(dt, new) and
updates all linked fields of type "Link"</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.rename_doc.rename_doctype" href="#frappe.model.rename_doc.rename_doctype" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>rename_doctype</b>
<i class="text-muted">(doctype, old, new, force=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.model.rename_doc.rename_dynamic_links" href="#frappe.model.rename_doc.rename_dynamic_links" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>rename_dynamic_links</b>
<i class="text-muted">(doctype, old, new)</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.model.rename_doc.rename_parent_and_child" href="#frappe.model.rename_doc.rename_parent_and_child" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>rename_parent_and_child</b>
<i class="text-muted">(doctype, old, new, meta)</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.model.rename_doc.rename_versions" href="#frappe.model.rename_doc.rename_versions" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>rename_versions</b>
<i class="text-muted">(doctype, old, new)</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.model.rename_doc.update_attachments" href="#frappe.model.rename_doc.update_attachments" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>update_attachments</b>
<i class="text-muted">(doctype, old, new)</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.model.rename_doc.update_child_docs" href="#frappe.model.rename_doc.update_child_docs" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>update_child_docs</b>
<i class="text-muted">(old, new, meta)</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.model.rename_doc.update_comments" href="#frappe.model.rename_doc.update_comments" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>update_comments</b>
<i class="text-muted">(doctype, old, new, force=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.model.rename_doc.update_link_field_values" href="#frappe.model.rename_doc.update_link_field_values" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>update_link_field_values</b>
<i class="text-muted">(link_fields, old, new, 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.model.rename_doc.update_options_for_fieldtype" href="#frappe.model.rename_doc.update_options_for_fieldtype" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>update_options_for_fieldtype</b>
<i class="text-muted">(fieldtype, old, new)</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.model.rename_doc.update_parenttype_values" href="#frappe.model.rename_doc.update_parenttype_values" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>update_parenttype_values</b>
<i class="text-muted">(old, new)</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.model.rename_doc.update_select_field_values" href="#frappe.model.rename_doc.update_select_field_values" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>update_select_field_values</b>
<i class="text-muted">(old, new)</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.model.rename_doc.validate_rename" href="#frappe.model.rename_doc.validate_rename" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.rename_doc.<b>validate_rename</b>
<i class="text-muted">(doctype, new, meta, merge, force, ignore_permissions)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>




<!-- autodoc -->

+ 0
- 66
frappe/docs/current/api/model/frappe.model.sync.html Ver arquivo

@@ -1,66 +0,0 @@
<!-- title: frappe.model.sync --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/sync.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.model.sync.get_doc_files" href="#frappe.model.sync.get_doc_files" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.sync.<b>get_doc_files</b>
<i class="text-muted">(files, start_path, force=0, sync_everything=False, verbose=False)</i>
</p>
<div class="docs-attr-desc"><p>walk and sync all doctypes and pages</p>
</div>
<br>


<p class="docs-attr-name">
<a name="frappe.model.sync.sync_all" href="#frappe.model.sync.sync_all" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.sync.<b>sync_all</b>
<i class="text-muted">(force=0, 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.model.sync.sync_for" href="#frappe.model.sync.sync_for" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.sync.<b>sync_for</b>
<i class="text-muted">(app_name, force=0, sync_everything=False, verbose=False)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>




<!-- autodoc -->

+ 0
- 66
frappe/docs/current/api/model/frappe.model.workflow.html Ver arquivo

@@ -1,66 +0,0 @@
<!-- title: frappe.model.workflow --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/workflow.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.model.workflow.get_default_state" href="#frappe.model.workflow.get_default_state" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.workflow.<b>get_default_state</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.model.workflow.get_state_fieldname" href="#frappe.model.workflow.get_state_fieldname" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.workflow.<b>get_state_fieldname</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.model.workflow.get_workflow_name" href="#frappe.model.workflow.get_workflow_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.workflow.<b>get_workflow_name</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
- 19
frappe/docs/current/api/model/index.html Ver arquivo

@@ -1,19 +0,0 @@
<!-- title: model -->


<div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>


<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/model"
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 -->

Alguns arquivos não foram mostrados porque muitos arquivos mudaram nesse diff

Escrever Pré-visualização
Carregando…
Cancelar
Salvar