基于Libreoffice的报表引擎(ODT -> ODT,ODT -> PDF,ODT -> DOC,ODT -> DOCX,ODS -> ODS等)
项目描述
报告Py3o
py3o报表引擎是基于Libreoffice的Odoo报表引擎
报表使用Libreoffice(ODT或ODS)创建
报表以OpenDocument格式(.odt或.ods文件)存储在服务器上
报表以OpenDocument格式或Libreoffice支持的任何输出格式(PDF、HTML、DOC、DOCX、Docbook、XLS等)发送给用户
基于Libreoffice的报表引擎的主要优势是
无需是开发者即可创建或修改报表:报表使用Libreoffice创建和修改。因此,此报表引擎具有完整的WYSIWYG报表开发工具!
对于A4/Letter格式的PDF报表,使用设计用于创建A4/Letter文档的工具(如Libreoffice)比使用HTML/CSS开发它更容易,而且HTML/CSS解决方案对一些打印特性(背景、边框框)的支持不是很好。
如果您希望用户能够在Odoo生成后修改文档,只需将文档配置为ODT输出(或DOC或DOCX),用户就可以使用Libreoffice(或Word)在Odoo生成后修改文档。
轻松开发ODS格式的电子表格报表(可能输出XLS)。
本报告引擎是 Aeroo 的替代方案:这两个报告引擎具有相似的功能,但它们的实现完全不同。尽管如此,您不能直接使用 aeroo 模板作为替代,您需要更改一些细节。
安装
安装所需的 python 库
pip install py3o.template
pip install py3o.formats
为了允许将 ODT 或 ODS 报告转换为其他格式(PDF、DOC、DOCX 等),请安装 libreoffice
apt-get --no-install-recommends install libreoffice
配置
例如,要使用自定义 py3o 报告替换原生发票报告,请将以下 XML 文件添加到您的自定义模块中
<?xml version="1.0" encoding="utf-8"?>
<odoo>
<record id="account.account_invoices" model="ir.actions.report.xml">
<field name="report_type">py3o</field>
<field name="py3o_filetype">odt</field>
<field name="module">my_custom_module_base</field>
<field name="py3o_template_fallback">report/account_invoice.odt</field>
</record>
</odoo>
其中 my_custom_module_base 是自定义 Odoo 模块的名称。在本例中,发票 ODT 文件位于 my_custom_module_base/report/account_invoice.odt。
您还可以引用位于 Odoo 服务器受信任路径中的模板。在这种情况下,必须将 module 条目留空,并将模板的路径指定为 py3o_template_fallback。
<?xml version="1.0" encoding="utf-8"?>
<odoo>
<record id="account.account_invoices" model="ir.actions.report.xml">
<field name="report_type">py3o</field>
<field name="py3o_filetype">odt</field>
<field name="py3o_template_fallback">/odoo/templates/py3o/report/account_invoice.odt</field>
</record>
</odoo>
此外,您还必须修改 Odoo 服务器配置文件,以声明 py3o 模板的允许根目录。只有位于此目录中的模板才能由 py3o 报告加载。
[options]
...
[report_py3o]
root_tmpl_path=/odoo/templates/py3o
如果您想以 PDF 格式而不是 ODT 格式生成发票,XML 文件应如下所示
<?xml version="1.0" encoding="utf-8"?>
<odoo>
<record id="account.account_invoices" model="ir.actions.report.xml">
<field name="report_type">py3o</field>
<field name="py3o_filetype">pdf</field>
<field name="module">my_custom_module_base</field>
<field name="py3o_template_fallback">report/account_invoice.odt</field>
</record>
</odoo>
如果您想添加新的 py3o PDF 报告(而不是替换原生报告),XML 文件应如下所示
<?xml version="1.0" encoding="utf-8"?>
<odoo>
<record id="partner_summary_report" model="ir.actions.report.xml">
<field name="name">Partner Summary</field>
<field name="model">res.partner</field>
<field name="report_name">res.partner.summary</field>
<field name="report_type">py3o</field>
<field name="py3o_filetype">pdf</field>
<field name="module">my_custom_module_base</field>
<field name="py3o_template_fallback">report/partner_summary.odt</field>
</record>
<!-- Add entry in "Print" drop-down list -->
<record id="button_partner_summary_report" model="ir.values">
<field name="key2">client_print_multi</field>
<field name="model">res.partner</field>
<field name="name">Partner Summary</field>
<field name="value" eval="'ir.actions.report.xml,%d'%partner_summary_report" />
</record>
</odoo>
配置参数
- py3o.conversion_command
用于运行转换的命令,默认为 libreoffice。如果您更改此设置,则在此处设置的任何内容都必须接受参数 --headless --convert-to $ext $file 并将结果文件放入 $file 目录中,文件扩展名为 $ext。该命令将在 $file 目录中启动。
用法
模板语言有详细的文档 extensively documented,记录作为 objects 在 libreoffice 中公开,您还可以在它们上调用函数。
可用的函数和对象
- user
浏览当前用户的记录
- lang
用户公司语言的字符串(ISO 代码)
- b64decode
base64.b64decode
- format_multiline_value(string)
生成多行字段的 ODF 等效的 <br/> 和 (ODF 内部是 XML,否则将跳过这些内容)
- html_sanitize(string)
净化 HTML 字符串
- time
Python 的 time 模块
- display_address(partner)
返回合作伙伴地址的格式化字符串
示例报告模板
主要 Odoo 原生报告(发票、销售订单、采购订单、拣选等)的示例 py3o 报告模板可在 Github 项目 odoo-py3o-report-templates 中找到。
已知问题/路线图
生成条码?
在演示文件中添加更多详细示例以展示功能
添加迁移指南 aeroo -> py3o
错误跟踪器
错误在 GitHub Issues 上跟踪。在遇到问题的情况下,请检查是否已报告您的问题。如果您是第一个发现它的人,请通过提供详细且受欢迎的反馈来帮助我们解决这个问题。
致谢
贡献者
弗洛伦特·艾德 (XCG Consulting)
劳伦特·米尼奥 <laurent.mignon@acsone.eu>
亚历克斯·德·拉特雷 <alexis.delattre@akretion.com>
郭文·巴孔尼耶 <guewen.baconnier@camptocamp.com>
奥马尔·卡斯蒂涅拉 <omar@comunitea.com>
霍尔格·布伦 <hbrunn@therp.nl>
维护者
本模块由OCA维护。
OCA,或Odoo社区协会,是一个非营利组织,其使命是支持Odoo功能的协作开发并推广其广泛应用。
要为此模块做出贡献,请访问 https://odoo-community.org。
项目详情
哈希值 用于 odoo10_addon_report_py3o-10.0.2.0.2-py2-none-any.whl
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 851cdf6e9e4c9bcdc06d20bc0caeac254b3e29544c5586f2e85344f51679c4de |
|
MD5 | 9f3ba3f3974c7cc247b0f900aec3766c |
|
BLAKE2b-256 | 47916c85e60fd990c738db5821562ca872e3b6ddb0d3e28b41efb93c91a73395 |