You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

489 line
13 KiB

  1. <!-- title: frappe.model.meta --><div class="dev-header">
  2. <a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
  3. Version 6.x.x</a>
  4. <a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/meta.py"
  5. target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
  6. </div>
  7. <h3 style="font-weight: normal;">Class <b>Meta</b></h3>
  8. <p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>
  9. <div class="docs-attr-desc"><p></p>
  10. </div>
  11. <div style="padding-left: 30px;">
  12. <p class="docs-attr-name">
  13. <a name="__init__" href="#__init__" class="text-muted small">
  14. <i class="icon-link small" style="color: #ccc;"></i></a>
  15. <b>__init__</b>
  16. <i class="text-muted">(self, doctype)</i>
  17. </p>
  18. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  19. </div>
  20. <br>
  21. <p class="docs-attr-name">
  22. <a name="add_custom_fields" href="#add_custom_fields" class="text-muted small">
  23. <i class="icon-link small" style="color: #ccc;"></i></a>
  24. <b>add_custom_fields</b>
  25. <i class="text-muted">(self)</i>
  26. </p>
  27. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  28. </div>
  29. <br>
  30. <p class="docs-attr-name">
  31. <a name="apply_property_setters" href="#apply_property_setters" class="text-muted small">
  32. <i class="icon-link small" style="color: #ccc;"></i></a>
  33. <b>apply_property_setters</b>
  34. <i class="text-muted">(self)</i>
  35. </p>
  36. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  37. </div>
  38. <br>
  39. <p class="docs-attr-name">
  40. <a name="get_dynamic_link_fields" href="#get_dynamic_link_fields" class="text-muted small">
  41. <i class="icon-link small" style="color: #ccc;"></i></a>
  42. <b>get_dynamic_link_fields</b>
  43. <i class="text-muted">(self)</i>
  44. </p>
  45. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  46. </div>
  47. <br>
  48. <p class="docs-attr-name">
  49. <a name="get_field" href="#get_field" class="text-muted small">
  50. <i class="icon-link small" style="color: #ccc;"></i></a>
  51. <b>get_field</b>
  52. <i class="text-muted">(self, fieldname)</i>
  53. </p>
  54. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  55. </div>
  56. <br>
  57. <p class="docs-attr-name">
  58. <a name="get_fields_to_check_permissions" href="#get_fields_to_check_permissions" class="text-muted small">
  59. <i class="icon-link small" style="color: #ccc;"></i></a>
  60. <b>get_fields_to_check_permissions</b>
  61. <i class="text-muted">(self, user_permission_doctypes)</i>
  62. </p>
  63. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  64. </div>
  65. <br>
  66. <p class="docs-attr-name">
  67. <a name="get_high_permlevel_fields" href="#get_high_permlevel_fields" class="text-muted small">
  68. <i class="icon-link small" style="color: #ccc;"></i></a>
  69. <b>get_high_permlevel_fields</b>
  70. <i class="text-muted">(self)</i>
  71. </p>
  72. <div class="docs-attr-desc"><p>Build list of fields with high perm level and all the higher perm levels defined.</p>
  73. </div>
  74. <br>
  75. <p class="docs-attr-name">
  76. <a name="get_label" href="#get_label" class="text-muted small">
  77. <i class="icon-link small" style="color: #ccc;"></i></a>
  78. <b>get_label</b>
  79. <i class="text-muted">(self, fieldname)</i>
  80. </p>
  81. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  82. </div>
  83. <br>
  84. <p class="docs-attr-name">
  85. <a name="get_link_fields" href="#get_link_fields" class="text-muted small">
  86. <i class="icon-link small" style="color: #ccc;"></i></a>
  87. <b>get_link_fields</b>
  88. <i class="text-muted">(self)</i>
  89. </p>
  90. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  91. </div>
  92. <br>
  93. <p class="docs-attr-name">
  94. <a name="get_list_fields" href="#get_list_fields" class="text-muted small">
  95. <i class="icon-link small" style="color: #ccc;"></i></a>
  96. <b>get_list_fields</b>
  97. <i class="text-muted">(self)</i>
  98. </p>
  99. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  100. </div>
  101. <br>
  102. <p class="docs-attr-name">
  103. <a name="get_options" href="#get_options" class="text-muted small">
  104. <i class="icon-link small" style="color: #ccc;"></i></a>
  105. <b>get_options</b>
  106. <i class="text-muted">(self, fieldname)</i>
  107. </p>
  108. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  109. </div>
  110. <br>
  111. <p class="docs-attr-name">
  112. <a name="get_search_fields" href="#get_search_fields" class="text-muted small">
  113. <i class="icon-link small" style="color: #ccc;"></i></a>
  114. <b>get_search_fields</b>
  115. <i class="text-muted">(self)</i>
  116. </p>
  117. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  118. </div>
  119. <br>
  120. <p class="docs-attr-name">
  121. <a name="get_select_fields" href="#get_select_fields" class="text-muted small">
  122. <i class="icon-link small" style="color: #ccc;"></i></a>
  123. <b>get_select_fields</b>
  124. <i class="text-muted">(self)</i>
  125. </p>
  126. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  127. </div>
  128. <br>
  129. <p class="docs-attr-name">
  130. <a name="get_table_field_doctype" href="#get_table_field_doctype" class="text-muted small">
  131. <i class="icon-link small" style="color: #ccc;"></i></a>
  132. <b>get_table_field_doctype</b>
  133. <i class="text-muted">(self, fieldname)</i>
  134. </p>
  135. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  136. </div>
  137. <br>
  138. <p class="docs-attr-name">
  139. <a name="get_table_fields" href="#get_table_fields" class="text-muted small">
  140. <i class="icon-link small" style="color: #ccc;"></i></a>
  141. <b>get_table_fields</b>
  142. <i class="text-muted">(self)</i>
  143. </p>
  144. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  145. </div>
  146. <br>
  147. <p class="docs-attr-name">
  148. <a name="get_title_field" href="#get_title_field" class="text-muted small">
  149. <i class="icon-link small" style="color: #ccc;"></i></a>
  150. <b>get_title_field</b>
  151. <i class="text-muted">(self)</i>
  152. </p>
  153. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  154. </div>
  155. <br>
  156. <p class="docs-attr-name">
  157. <a name="get_valid_columns" href="#get_valid_columns" class="text-muted small">
  158. <i class="icon-link small" style="color: #ccc;"></i></a>
  159. <b>get_valid_columns</b>
  160. <i class="text-muted">(self)</i>
  161. </p>
  162. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  163. </div>
  164. <br>
  165. <p class="docs-attr-name">
  166. <a name="load_from_db" href="#load_from_db" class="text-muted small">
  167. <i class="icon-link small" style="color: #ccc;"></i></a>
  168. <b>load_from_db</b>
  169. <i class="text-muted">(self)</i>
  170. </p>
  171. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  172. </div>
  173. <br>
  174. <p class="docs-attr-name">
  175. <a name="process" href="#process" class="text-muted small">
  176. <i class="icon-link small" style="color: #ccc;"></i></a>
  177. <b>process</b>
  178. <i class="text-muted">(self)</i>
  179. </p>
  180. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  181. </div>
  182. <br>
  183. <p class="docs-attr-name">
  184. <a name="sort_fields" href="#sort_fields" class="text-muted small">
  185. <i class="icon-link small" style="color: #ccc;"></i></a>
  186. <b>sort_fields</b>
  187. <i class="text-muted">(self)</i>
  188. </p>
  189. <div class="docs-attr-desc"><p>sort on basis of previous_field</p>
  190. </div>
  191. <br>
  192. </div>
  193. <hr>
  194. <p class="docs-attr-name">
  195. <a name="frappe.model.meta.clear_cache" href="#frappe.model.meta.clear_cache" class="text-muted small">
  196. <i class="icon-link small" style="color: #ccc;"></i></a>
  197. frappe.model.meta.<b>clear_cache</b>
  198. <i class="text-muted">(doctype=None)</i>
  199. </p>
  200. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  201. </div>
  202. <br>
  203. <p class="docs-attr-name">
  204. <a name="frappe.model.meta.get_default_df" href="#frappe.model.meta.get_default_df" class="text-muted small">
  205. <i class="icon-link small" style="color: #ccc;"></i></a>
  206. frappe.model.meta.<b>get_default_df</b>
  207. <i class="text-muted">(fieldname)</i>
  208. </p>
  209. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  210. </div>
  211. <br>
  212. <p class="docs-attr-name">
  213. <a name="frappe.model.meta.get_field_currency" href="#frappe.model.meta.get_field_currency" class="text-muted small">
  214. <i class="icon-link small" style="color: #ccc;"></i></a>
  215. frappe.model.meta.<b>get_field_currency</b>
  216. <i class="text-muted">(df, doc=None)</i>
  217. </p>
  218. <div class="docs-attr-desc"><p>get currency based on DocField options and fieldvalue in doc</p>
  219. </div>
  220. <br>
  221. <p class="docs-attr-name">
  222. <a name="frappe.model.meta.get_field_precision" href="#frappe.model.meta.get_field_precision" class="text-muted small">
  223. <i class="icon-link small" style="color: #ccc;"></i></a>
  224. frappe.model.meta.<b>get_field_precision</b>
  225. <i class="text-muted">(df, doc=None, currency=None)</i>
  226. </p>
  227. <div class="docs-attr-desc"><p>get precision based on DocField options and fieldvalue in doc</p>
  228. </div>
  229. <br>
  230. <p class="docs-attr-name">
  231. <a name="frappe.model.meta.get_meta" href="#frappe.model.meta.get_meta" class="text-muted small">
  232. <i class="icon-link small" style="color: #ccc;"></i></a>
  233. frappe.model.meta.<b>get_meta</b>
  234. <i class="text-muted">(doctype, cached=True)</i>
  235. </p>
  236. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  237. </div>
  238. <br>
  239. <p class="docs-attr-name">
  240. <a name="frappe.model.meta.get_parent_dt" href="#frappe.model.meta.get_parent_dt" class="text-muted small">
  241. <i class="icon-link small" style="color: #ccc;"></i></a>
  242. frappe.model.meta.<b>get_parent_dt</b>
  243. <i class="text-muted">(dt)</i>
  244. </p>
  245. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  246. </div>
  247. <br>
  248. <p class="docs-attr-name">
  249. <a name="frappe.model.meta.get_table_columns" href="#frappe.model.meta.get_table_columns" class="text-muted small">
  250. <i class="icon-link small" style="color: #ccc;"></i></a>
  251. frappe.model.meta.<b>get_table_columns</b>
  252. <i class="text-muted">(doctype)</i>
  253. </p>
  254. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  255. </div>
  256. <br>
  257. <p class="docs-attr-name">
  258. <a name="frappe.model.meta.is_single" href="#frappe.model.meta.is_single" class="text-muted small">
  259. <i class="icon-link small" style="color: #ccc;"></i></a>
  260. frappe.model.meta.<b>is_single</b>
  261. <i class="text-muted">(doctype)</i>
  262. </p>
  263. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  264. </div>
  265. <br>
  266. <p class="docs-attr-name">
  267. <a name="frappe.model.meta.load_doctype_from_file" href="#frappe.model.meta.load_doctype_from_file" class="text-muted small">
  268. <i class="icon-link small" style="color: #ccc;"></i></a>
  269. frappe.model.meta.<b>load_doctype_from_file</b>
  270. <i class="text-muted">(doctype)</i>
  271. </p>
  272. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  273. </div>
  274. <br>
  275. <p class="docs-attr-name">
  276. <a name="frappe.model.meta.set_fieldname" href="#frappe.model.meta.set_fieldname" class="text-muted small">
  277. <i class="icon-link small" style="color: #ccc;"></i></a>
  278. frappe.model.meta.<b>set_fieldname</b>
  279. <i class="text-muted">(field_id, fieldname)</i>
  280. </p>
  281. <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
  282. </div>
  283. <br>
  284. <p class="docs-attr-name">
  285. <a name="frappe.model.meta.trim_tables" href="#frappe.model.meta.trim_tables" class="text-muted small">
  286. <i class="icon-link small" style="color: #ccc;"></i></a>
  287. frappe.model.meta.<b>trim_tables</b>
  288. <i class="text-muted">()</i>
  289. </p>
  290. <div class="docs-attr-desc"><p>Use this to remove columns that don't exist in meta</p>
  291. </div>
  292. <br>
  293. <!-- autodoc -->