majorsilence-reporting

安装

通过 PyPI 安装(需要 Python 3.10+):

# PyPI
pip install majorsilence-reporting

# 或以可编辑模式从源代码安装
pip install -e .

无运行时依赖——仅使用 Python 标准库(subprocess、ctypes、tempfile)。

集成模式

根据你部署报表引擎的方式,提供三个可用的类:

Report —— 子进程(dotnet)

from majorsilence_reporting import Report

rpt = Report(
    report_path  = '/path/to/report.rdl',
    rdl_cmd_path = '/path/to/RdlCmd.dll',
)
rpt.set_connection_string('Data Source=/path/to/data.db')
rpt.set_parameter('StartDate', '2026-01-01')

# 保存为文件
rpt.export('pdf', '/tmp/output.pdf')

# 或在内存中获取字节(例如用于 Flask 响应)
data = rpt.export_to_memory('pdf')
return Response(data, mimetype='application/pdf')

ReportAot —— AOT 二进制

与 Report 使用相同的 API,但指向自包含的二进制文件,而非 DLL。服务器无需 .NET 运行时。

from majorsilence_reporting import ReportAot

rpt = ReportAot(
    report_path  = '/path/to/report.rdl',
    rdl_cmd_path = '/path/to/RdlCmd',   # 自包含二进制文件,无 .dll 扩展名
)
rpt.set_connection_string('Data Source=/path/to/data.db')
data = rpt.export_to_memory('xlsx')

# ReportAot 还支持 xlsx_table、tifb 和 mht
data = rpt.export_to_memory('xlsx_table')

report_native —— 进程内 FFI

原生模式通过 ctypes 将 librdlnative.so 直接加载到 Python 进程中。不会启动任何子进程,是延迟最低的选项。它还支持真正的内存渲染——报表字节直接从原生缓冲区返回,无需写入临时文件。

from majorsilence_reporting.report_native import load_library, Report

# 在进程启动时调用一次。加载 librdlnative.so 及所有相关库。
lib = load_library('/path/to/librdlnative.so')

rpt = Report(lib, report_path='/path/to/report.rdl')
rpt.set_connection_string('Data Source=/path/to/data.db')

# 直接从原生缓冲区返回字节——不写入临时文件
data = rpt.export_to_memory('pdf')

# 作为二进制响应传递给 Django / FastAPI / Flask
return Response(data, media_type='application/pdf')

核心 API

三个类共享同一接口:

内存数据集

report_native.Report 支持通过 add_data() 完全在内存中提供数据——无需数据库连接。传入数据集名称和一个字典列表,其中每个值都是字符串。

from majorsilence_reporting.report_native import load_library, Report

lib = load_library('/path/to/librdlnative.so')
rpt = Report(lib, report_path='/path/to/report.rdl')

rpt.add_data('SalesData', [
    {'Product': 'PDF Library Pro',  'Revenue': '1200.00', 'Units': '3'},
    {'Product': 'Report Designer',   'Revenue': '250.00',  'Units': '1'},
    {'Product': 'Support (12 mo.)',  'Revenue': '500.00',  'Units': '1'},
])

data = rpt.export_to_memory('pdf')

导出格式