Changelog

odoo/upgrade-util#339

Created by Upgrade, Christophe Simonis (chs)

Merged at 58851b2fd74b79ea7ee6798479d97e9a7b5428ee

Statuses:

ci/runbot: Test upgrades between stable versions
ci/upgrade_enterprise: Test upgrades for enterprise master

label: odoo-dev:master-explode-formatter-chs
head: 4eacbc8ce85708ce81a94b0b6f85ab3d4ad78930
merged: 5 months ago by Upgrade, Christophe Simonis (chs)

	odoo/upgrade-util
master	#339

[IMP] util.explode_query{,_range}: only format the `{parallel_filter}` placeholder

The usage of str.format to inject the parallel filter used to explode queries is not robust to the presence of other curly braces. Examples:

JSON strings (typically to leverage their mapping capabilities):

See 79f3d7184285e39b04a6c032aec0e05de6565fe8, where a query had to be modified to accommodate that.

Hardcoded sets of curly braces:

&gt;&gt;&gt; &#34;UPDATE t SET c = &#39;{usage as literal characters}&#39; WHERE {parallel_filter}&#34;.format(parallel_filter=&#34;…&#34;)
Traceback (most recent call last):
  File &#34;&lt;stdin&gt;&#34;, line 1, in &lt;module&gt;
KeyError: &#39;usage as literal characters&#39;

Which can be (unelegantly) solved adding even more braces, leveraging one side effect of str.format:

&gt;&gt;&gt; &#34;UPDATE t SET c = &#39;{{usage as literal characters}}&#39; WHERE {parallel_filter}&#34;.format(parallel_filter=&#34;…&#34;)
&#34;UPDATE t SET c = &#39;{usage as literal characters}&#39; WHERE …&#34;

Hardcoded single unpaired curly braces (AFAICT no way to solve this):

&gt;&gt;&gt; &#34;UPDATE t SET c = &#39;this is an open curly brace = {&#39; WHERE {parallel_filter}&#34;.format(parallel_filter=&#34;…&#34;)
Traceback (most recent call last):
  File &#34;&lt;stdin&gt;&#34;, line 1, in &lt;module&gt;
ValueError: unexpected &#39;{&#39; in field name

&gt;&gt;&gt; &#34;UPDATE t SET c = &#39;this is a close brace = }&#39; WHERE {parallel_filter}&#34;.format(parallel_filter=&#34;…&#34;)
Traceback (most recent call last):
  File &#34;&lt;stdin&gt;&#34;, line 1, in &lt;module&gt;
ValueError: Single &#39;}&#39; encountered in format string

To circumvent this, we now use a dedicated Formatter that only handle the {parallel_filter} placeholder. This has the advantage of still deduplicate the doubled curly braces (see point 2 above) and thus being retro-compatible.

This doesn't solve the single unpaired curly braces case, but this is rare enough to be handled by other means.

Alternative to #142