SuperAPI AI 工具集

frappe-api

编程与开发

查看项目

更新于 10-16 00:04

技能介绍

用途:这是一份 Frappe 框架的 API 参考,用于在开发 Frappe 应用时查阅 Python 与 JavaScript 侧的文档操作、数据库查询、工具函数以及前后端通信写法。

主要能力:

  1. Python 文档 API:使用 frappe.get_doc、frappe.new_doc、doc.insert、doc.save、frappe.db.set_value、frappe.delete_doc 等进行增删改查,支持 ignore_permissions、ignore_mandatory、force 等参数。
  2. 数据库 API:frappe.db.get_value、frappe.db.get_all(支持 filters、fields、order_by、limit、pluck)、frappe.db.count、frappe.db.exists,以及 frappe.db.sql 原生 SQL,支持位置参数与命名参数、as_dict。
  3. 白名单接口:用 @frappe.whitelist() 暴露方法,可设置 allow_guest=True 或 methods=["POST"]。
  4. 工具函数:frappe.utils 下的日期时间(nowdate、add_days、date_diff、get_first_day 等)、数字(flt、cint、cstr、fmt_money、rounded)、字符串(strip_html、escape_html、scrub、unscrub)。
  5. 消息与后台任务:frappe.msgprint、frappe.throw、frappe.sendmail、frappe.publish_realtime、frappe.enqueue 及 hooks.py 中的 scheduler_events 定时任务。
  6. JavaScript 侧:frappe.call 调用接口,frappe.ui.form.on 处理表单事件、子表事件、set_df_property、set_query,以及 frappe.prompt、frappe.ui.Dialog、frappe.confirm、frappe.set_route 等。
  7. REST API:基于 token 或 session 认证,对 /api/resource/{Doctype} 做 GET/POST/PUT/DELETE,并通过 /api/method/ 调用白名单方法。

使用方式:按需检索对应 API 段落,参照示例修改参数后调用。Python 侧用于服务端脚本与钩子,JavaScript 侧用于客户端表单与交互,REST API 用于外部系统集成。

限制:资料未提供 Frappe 的安装部署、版本兼容性、性能与安全配置说明,相关细节暂未提供。