♻️ Implement Dunder __interface__ Method and Remove userdoc and devdoc Sanity Check
#235
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
vyper v0.4.0rc2 adds the `.__interface__` shorthand for exporting all the functions in a module. refactor to use this shorthand, saving some typing and eye-strain :)
pcaversaccio
changed the title
.__interface____interface__ Method
pcaversaccio
added
the
documentation 📖
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
pcaversaccio
changed the title
__interface__ Method__interface__ Method and Remove userdoc and devdoc Sanity Check
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
pcaversaccio
approved these changes
Apr 15, 2024
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.
🕓 Changelog
This PR refactors the existing module-friendly contracts to use the new dunder method
__interface__(see vyperlang/vyper#3919), which allows you to export all functions of a module without specifying the individual functions.We apply the following rules:
exportssyntax due to explicitness (application developers can thus identify faster what is exported within a library module),externalfunction is exported. We do not use it in mock contracts if critical code comments for exported functions would be lost.Furthermore, we remove the
userdocanddevdoccompilation script & CI pipeline since it's now computed as part of the standard compilation pipeline (vyperlang/vyper#3946).🐶 Cute Animal Picture