Skip to main content

Base module to create csv report

Project description

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runbot

This module provides a basic report class to generate csv report.

Table of contents


In case the exported CSV report should be encoded in another system than UTF-8, following fields of the report record (Settings > Technical > Reports) should be populated accordingly.

  • Encoding: set an encoding system (such as cp932)

  • Encode Error Handling: select ‘Ignore’ or ‘Replace’ as necessary.

    • ‘Ignore’: in case of an encoding error, the problematic character will be removed from the exported file.

    • ‘Replace’: in case of an encoding error, the problematic character will be replaced with ‘?’ symbol.

    • Leaving the field blank: in case of an encoding error, the report generation fails with an error message.


An example of CSV report for partners on a module called module_name:

A python class

from odoo import models

class PartnerCSV(models.AbstractModel):
    _name = 'report.report_csv.partner_csv'
    _inherit = 'report.report_csv.abstract'

    def generate_csv_report(self, writer, data, partners):
        for obj in partners:

    def csv_report_options(self):
        res = super().csv_report_options()
        res['delimiter'] = ';'
        res['quoting'] = csv.QUOTE_ALL
        return res

A report XML record

    string="Print to CSV"

Update encoding with an appropriate value (e.g. cp932) as necessary.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.



  • Creu Blanca



This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/reporting-engine project on GitHub.

You are welcome to contribute. To learn how please visit

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release. See tutorial on generating distribution archives.

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page