refactor: Improve Error Messaging for Export Collisions in Module Analysis #4719
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
vyper/semantics/analysis/module.py
Outdated
Comment on lines
569
to
577
| try: | ||
| self._self_t.typ.add_member(func_t.name, func_t) | ||
| except NamespaceCollision as e: | ||
| export_name = item.node_source_code | ||
| # Re-raise with more specific message mentioning the export | ||
| raise NamespaceCollision( | ||
| f"Member '{func_t.name}' already exists in self (when exporting `{export_name}`)", | ||
| prev_decl=e.prev_decl | ||
| ) from e |
There was a problem hiding this comment.
this try/catch block seems a little ad hoc to me. would it be better to fix it at the source (where NamespaceCollision is raised in the first place)?
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
Enhanced the clarity of exception messages raised during function export collisions in visit_ExportsDecl and _add_exposed_function.
How I did it
Wrapped the add_member call in a try-except block to catch NamespaceCollision and re-raise with a more descriptive message including the name of the export.
Updated StructureException to include the export name when a function is already exported.
How to verify it
Run the affected test cases in test_exports.py. Verify that the exceptions now provide more detailed messages referencing the specific export that caused the conflict.
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
Improved the clarity of error messages raised during export collisions in module analysis by including the export name in the exception messages.
Cute Animal Picture