fix[ux]: include imported structs in interface output #4362
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
|
Should the name of a struct include module name, id? |
vyper/compiler/output.py
Outdated
| @@ -159,6 +161,19 @@ def build_interface_output(compiler_data: CompilerData) -> str: | |||
| return out | |||
|
|
|||
|
|
|||
| def _get_structs(m: ModuleT, visited: set[ModuleT] = None) -> [StructT]: | |||
There was a problem hiding this comment.
we can use ModuleT.reachable_imports here instead of implementing the recursion
There was a problem hiding this comment.
I kept the recursion because for building the import paths for the output - a.b.c. struct.
vyper/compiler/output.py
Outdated
| if m in visited: | ||
| return [] | ||
| visited.add(m) | ||
| structs = list(m.interface.structs.values()) |
There was a problem hiding this comment.
hmm. what if two modules have a struct with the same name?
There was a problem hiding this comment.
yeah, that's what i was getting at with #4362 (comment), I'll prepend it.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4362 +/- ##
==========================================
- Coverage 91.86% 91.06% -0.80%
==========================================
Files 119 119
Lines 16640 16653 +13
Branches 2801 2804 +3
==========================================
- Hits 15286 15165 -121
- Misses 929 1040 +111
- Partials 425 448 +23 ☔ View full report in Codecov by Sentry. |
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.
What I did
Included structs from imported modules in the
-f interfaceoutput. Fix the #4298 issue.How I did it
Added a function that recursively walks imported modules and collects structs. It contains
visitedset to track which imports were already handled.How to verify it
Added test cases and previous test cases work.
Commit message
Commit message for the final, squashed PR. (Optional, but reviewers will appreciate it! Please see our commit message style guide for what we would ideally like to see in a commit message.)
Description for the changelog
Cute Animal Picture