[IMP] util.explode_query{,_range}: only format the {parallel_filter} placeholder
#339
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
Pirols
reviewed
Oct 10, 2025
| ] | ||
| ) | ||
| def test_ExplodeFormatter(self, value, expected): | ||
| formatted = util.pg._ExplodeFormatter().format(value, parallel_filter="…") |
There was a problem hiding this comment.
Suggested change
| formatted = util.pg._ExplodeFormatter().format(value, parallel_filter="…") | |
| formatted = util.pg._ExplodeFormatter().format(value, parallel_filter="...") |
np: I can imagine someone trying to add a test case being confused by the unicode character here.
There was a problem hiding this comment.
It was copied from the commit message stolen from #142
There was a problem hiding this comment.
It did look familiar. :p
For what it's worth, I have since removed the vim abbrev rule that replaced triple dots with that one.
|
upgradeci retry with always only crm |
KangOl
force-pushed
the
master-explode-formatter-chs
branch
from
e1f7f15 to
0a2a432
Compare
aj-fuentes
reviewed
Oct 10, 2025
aj-fuentes
reviewed
Oct 10, 2025
src/util/pg.py
Outdated
| sep_kw = " AND " if re.search(r"\sWHERE\s", query, re.M | re.I) else " WHERE " | ||
| query += sep_kw + "{parallel_filter}" | ||
|
|
||
| fmt = _ExplodeFormatter().format |
There was a problem hiding this comment.
Why don't we put this in the global scope, right after the definition of _ExplodeFormatter? It can be reused in explode_query for example.
There was a problem hiding this comment.
Let's try. I added a fixup commit to see if the final result adds up.
There was a problem hiding this comment.
Why don't we put this in the global scope, right after the definition of
_ExplodeFormatter? It can be reused inexplode_queryfor example.
So, do I squash this commit with the _explode_format variable?
KangOl
force-pushed
the
master-explode-formatter-chs
branch
from
0a2a432 to
efc6c9e
Compare
…` 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: 1. `JSON` strings (typically to leverage their mapping capabilities): See 79f3d71, where a query had to be modified to accommodate that. 2. Hardcoded sets of curly braces: ```python >>> "UPDATE t SET c = '{usage as literal characters}' WHERE {parallel_filter}".format(parallel_filter="…") Traceback (most recent call last): File "<stdin>", line 1, in <module> KeyError: 'usage as literal characters' ``` Which can be (unelegantly) solved adding even more braces, leveraging one side effect of `str.format`: ```python >>> "UPDATE t SET c = '{{usage as literal characters}}' WHERE {parallel_filter}".format(parallel_filter="…") "UPDATE t SET c = '{usage as literal characters}' WHERE …" ``` 3. Hardcoded single unpaired curly braces (AFAICT no way to solve this): ```python >>> "UPDATE t SET c = 'this is an open curly brace = {' WHERE {parallel_filter}".format(parallel_filter="…") Traceback (most recent call last): File "<stdin>", line 1, in <module> ValueError: unexpected '{' in field name ``` ```python >>> "UPDATE t SET c = 'this is a close brace = }' WHERE {parallel_filter}".format(parallel_filter="…") Traceback (most recent call last): File "<stdin>", line 1, in <module> ValueError: Single '}' 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.
KangOl
force-pushed
the
master-explode-formatter-chs
branch
from
efc6c9e to
4eacbc8
Compare
|
@robodoo r+ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The usage of
str.formatto inject the parallel filter used to explode queries is not robust to the presence of other curly braces. Examples:JSONstrings (typically to leverage their mapping capabilities):See 79f3d71, where a query had to be modified to accommodate that.
Which can be (unelegantly) solved adding even more braces, leveraging one side effect of
str.format: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