Fix #548: use == instead of in for string comparison in Python/.tpl
#551
Conversation
This file contains 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
The use of `in` for string comparison results in `"name" in "name2"` giving a false positive; the right thing is to use `==`. In peripheral_subsystem.sv.tpl, this may result in the peripheral being added twice, or being added when it shouldn't. This has been fixed in this commit. In addition, the way in which dict keys are handled has been changed from iterating through all the keys to just finding the relevant key.
This is the same issue that was found at bug esl-epfl#548, although in this case it has not shown any adverse effects *for now*. Nevertheless, it is never a bad idea to fix it as well just in case. Also fixed file `pad_cfg.hjson` which incorrectly adds a comma after quoteless string `active: low,` which isn't valid Hjson. This worked before because `"low" in "low,"` is technically true, but this was just one bug hiding another bug. This issue affects several other files and will be reported separately.
| @@ -219,7 +219,7 @@ def __init__(self, name, cell_name, pad_type, pad_mapping, index, pad_active, pa | |||
| self.pad_mapping = pad_mapping | |||
| self.pad_mux_list = pad_mux_list | |||
|
|
|||
| if('low' in pad_active): | |||
| if pad_active == 'low': | |||
There was a problem hiding this comment.
what if there are commas , in the hjson file?
There was a problem hiding this comment.
There shouldn't. Not in a valid Hjson file at least.
https://hjson.github.io/syntax.html
Do not add commas or comments as they would become part of the string.
Note that I fixed the affected Hjson file in this commit, so that should not be an issue in this particular case.
(But feel free to ditch the second commit of the PR and pull only the first one if you're not sure about that yet.)
Also see issue #552 which I created just now, immediately after submitting this PR, as I realized about that issue while dealing with this one.
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.
The use of
infor string comparison results in"name" in "name2"giving a false positive; the right thing is to use==.In peripheral_subsystem.sv.tpl, this may result in the peripheral being added twice, or being added when it shouldn't. This was reported in #548, and has been fixed in this PR.
This misuse of
inalso occurs in mcu_gen.py and has been fixed as well.In addition, this PR also changes the way in which dict keys are handled, from iterating through all the keys to just finding the relevant key, which is more readable (and efficient).