使用方法
- 复制安装命令,在自己的智能体环境安装前先检查源码包。
- 从原始文档核对所需工具、凭据和支持的宿主。
- 说明输入材料与期望交付物,并对照来源检查输出。
npx skills add https://github.com/sbknext/forge-frappe-skill --skill frappe-report-development开始前需了解
- 安装不包含模型订阅、API 额度或访问文件的权限。
- 仓库星数和安装量反映活跃情况,不等于独立质量或安全测试。
按源仓库内容呈现,保留标题、案例、代码、表格、链接以及原文引用的演示图片。
Frappe Report Development
Three report types: Report Builder (no code, UI), Query Report (one SQL), Script Report (Python, full control). Use Query for simple tabular, Script for computed/multi-step.
Query Report
Create a Report (type = Query Report), put SQL in the query box. Filters are referenced as %(key)s:
SELECT
so.name AS "Order:Link/Sales Order:160",
so.customer AS "Customer:Link/Customer:200",
so.grand_total AS "Total:Currency:120"
FROM `tabSales Order` so
WHERE so.docstatus = 1
AND so.company = %(company)s
AND so.transaction_date BETWEEN %(from_date)s AND %(to_date)s
ORDER BY so.transaction_dateColumn header syntax: Label:Fieldtype/Options:Width. Filters injected as named %(...)s params — safe.
Script Report
# myapp/myapp/report/order_summary/order_summary.py
import frappe
def execute(filters=None):
filters = filters or {}
columns = [
{"label": "Customer", "fieldname": "customer", "fieldtype": "Link", "options": "Customer", "width": 200},
{"label": "Total", "fieldname": "total", "fieldtype": "Currency", "width": 120},
]
rows = frappe.db.sql("""
SELECT customer, SUM(grand_total) AS total
FROM `tabSales Order`
WHERE docstatus = 1 AND company = %(company)s
GROUP BY customer
""", filters, as_dict=True)
chart = {
"data": {"labels": [r.customer for r in rows],
"datasets": [{"values": [r.total for r in rows]}]},
"type": "bar",
}
return columns, rows, None, chart # columns, data, message, chart, report_summaryFilters (report .js)
frappe.query_reports["Order Summary"] = {
filters: [
{ fieldname: "company", label: "Company", fieldtype: "Link", options: "Company", reqd: 1 },
{ fieldname: "from_date", label: "From", fieldtype: "Date", default: frappe.datetime.month_start() },
{ fieldname: "to_date", label: "To", fieldtype: "Date", default: frappe.datetime.get_today() },
],
formatter(value, row, column, data, default_formatter) {
value = default_formatter(value, row, column, data);
if (column.fieldname === "total" && data.total > 100000)
value = `<span style="color:green">${value}</span>`;
return value;
},
};Rules
- Query Reports: only
%(name)sparams — never string-concat filter values (injection). - Set report roles so only intended users can run/export it.
- Heavy aggregations → add indexes, or precompute into a summary DocType refreshed by a scheduler job.
- Return a
chartdict for a built-in visualization;report_summaryfor top KPI cards. - For huge exports, prefer a background job writing a file over a synchronous report run.
- Report print formats: drop
{report_name}.htmlbeside the report.py/.js— client-side microtemplating (not Jinja); data available asdata,filters,report.
Source: https://docs.frappe.io/framework/user/en/desk/printing , https://docs.frappe.io/framework/user/en/guides/reports-and-printing/print-format-for-reports