Changelog

odoo/upgrade-util#360

Created by Upgrade, Oskar Wielgos (owi)

Blocked

Merge method
Review
CI
- ci/runbot: Test upgrades between stable versions
- ci/upgrade_enterprise: Test upgrades for enterprise master
Linked pull requests
- odoo/upgrade#8968

label: odoo-dev:master-add_report-owi
head: 64d430bcc10087d0056c5e93eeef115f4a1bee9c

	odoo/upgrade	odoo/upgrade-util
master	#8968 ^{missing r+}	#360 ^{missing r+}

[ADD] util/report: util.add_report

Add a new function that replaces util.add_to_migration_reports.

The new function can automatically parse the provided data as a list of records. It can also limit the number of displayed records to prevent the upgrade report from growing too large.

The structure of the note is now defined within the function itself, standardizing its appearance.

Example usage

More examples will follow in odoo/upgrade, replacing the existing use of util.add_to_migration_reports.

Example 1

cr.execute(
        &#34;&#34;&#34;
        SELECT p.id, p.name, p.city, p.comment, p.company_id, com.name FROM res_partner p
          JOIN res_company com
            ON p.company_id = com.id
        &#34;&#34;&#34;
    )

summary = &#34;&#34;&#34;
    This is a test of the utility method that is displaying a list of rows
    returned by an SQL query. The number of displayed rows is limited.
    &#34;&#34;&#34;
row_format = &#34;Partner with id {partner_link} works at company {company_link} in {city}, ({comment})&#34;
columns = (&#34;id&#34;, &#34;name&#34;, &#34;city&#34;, &#34;comment&#34;, &#34;company_id&#34;, &#34;company_name&#34;)
links = {&#34;company_link&#34;: (&#34;res.company&#34;, &#34;company_id&#34;, &#34;company_name&#34;), &#34;partner_link&#34;: (&#34;res.partner&#34;, &#34;id&#34;, &#34;name&#34;)}
util.add_report(header=&#34;Test of the new utility method&#34;, summary=summary, row_format=row_format, columns=columns, links=links, data=cr.fetchall())

Example 2

util.add_report(header=&#34;Simple note&#34;, summary=&#34;A detailed description of the change.&#34;)

Example 3

msg = &#34;&#34;&#34;
This is some text in **bold**.  

This is a line  
that should break.

- Item one
- Item two
    - Sub-item

And some _italic_ text.
&#34;&#34;&#34;
util.add_report(header=&#34;MD note&#34;, summary=msg, report_format=&#34;md&#34;)

Example 4

msg = &#34;&#34;&#34;
This is some text in **bold**.

| This is a line
| that should break.

* Item one
* Item two

  * Sub-item

And some *italic* text.
&#34;&#34;&#34;
util.add_report(header=&#34;RST note&#34;, summary=msg, report_format=&#34;rst&#34;)

Remaining details to discuss

The introduction of env var to control limit.
Enforce/assert the use of tuples instead of lists. Currently, it's possible to pass a list for columns (instead of a tuple) or a dictionary of lists for links (instead of a dictionary of tuples).
How to handle depreciation of add_to_migration_reports.
Indentation of the ir.ui.view record corresponding to the note is sometimes incorrect (previously there was the same issue):
<img width="1527" height="540" alt="image" src="https://github.com/user-attachments/assets/5e9cf10d-2c7f-4898-b842-5bffd1ec231f" />