Recognize ${braced} variables in template extract_vars#1455
Open
c-tonneslan wants to merge 1 commit into
Open
Conversation
extract_vars only collected the `named` group from string.Template's
match, so ${var} placeholders were invisible to it. string.Template
matches a variable as either $named or ${braced}, and both are valid.
Two consequences: Template.vars() under-reported, missing any ${var};
and interpolate()'s MissingVariables check never saw them, so a
template using ${missing} raised a raw KeyError from substitute()
instead of the intended MissingVariables error.
Collect the `braced` group as well.
Signed-off-by: Charlie Tonneslan <cst0520@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Template.extract_varsonly collects thenamedgroup fromstring.Template's match:But
string.Templatematches a variable as either$namedor${braced}, and both forms are valid. So${var}placeholders are invisible toextract_vars, with two consequences:Template.vars()under-reports —Template(name="x", prompt="Hello ${name}").vars()returnsset()instead of{"name"}.interpolate()'s missing-variable check never sees them, so a template using${missing}raises a rawKeyErrorout ofstring.Template.substitute()instead of the intendedTemplate.MissingVariableserror.>>> Template.interpolate("Hi ${who}", {}) KeyError: 'who' # expected: MissingVariables: Missing variables: whoFix collects the
bracedgroup too. Added${braced}cases (resolve, missing, and mixed$a+${b}) to the existingtest_template_evaluateparametrize list — the missing-variable case fails onmainwith a rawKeyErrorand passes with the fix. Fulltest_templates.py(49 tests) green.