-
Notifications
You must be signed in to change notification settings - Fork 375
Fix/1423 clear docstring #1706
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Anuoluwapo25
wants to merge
9
commits into
ethereum:forks/osaka
Choose a base branch
from
Anuoluwapo25:fix/1423-clear-docstring
base: forks/osaka
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Fix/1423 clear docstring #1706
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
3c9bc4b
feat: commit-message-format
Anuoluwapo25 0cd7ec8
fix: 1423 clear-doc-string-on-new-fork
Anuoluwapo25 26b1104
Merge branch 'fix/1423-clear-docstring' of https://github.com/Anuoluwβ¦
Anuoluwapo25 30ff493
Fix: merge conflict
Anuoluwapo25 e083ff0
Merge branch 'ethereum:forks/osaka' into fix/1423-clear-docstring
Anuoluwapo25 952cd1a
Update remove_docstring.py
SamWilsn d74be18
test(new_fork): verify doc-string removal only in new fork __init__.py
Anuoluwapo25 84e3320
Merge branch 'fix/1423-clear-docstring' of https://github.com/Anuoluwβ¦
Anuoluwapo25 6f171a0
test(new_fork): add tests for selective docstring removal
Anuoluwapo25 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
32 changes: 32 additions & 0 deletions
32
src/ethereum_spec_tools/new_fork/codemod/remove_docstring.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| """ | ||
| libcst codemod that removes the module docstring. | ||
| """ | ||
| import libcst as cst | ||
| from libcst.codemod import CodemodCommand, CodemodContext | ||
| from typing_extensions import override | ||
|
|
||
| class RemoveDocstringCommand(CodemodCommand): | ||
| """ | ||
| Removes the module docstring if it exists. | ||
| """ | ||
| DESCRIPTION: str = "Remove the module docstring." | ||
|
|
||
| @override | ||
| def transform_module_impl(self, tree: cst.Module) -> cst.Module: | ||
| """ | ||
| Transform the tree by removing the docstring. | ||
| """ | ||
| if len(tree.body) == 0: | ||
| return tree | ||
| first_stmt = tree.body[0] | ||
| if not isinstance(first_stmt, cst.SimpleStatementLine): | ||
| return tree | ||
| if len(first_stmt.body) != 1: | ||
| return tree | ||
| expr = first_stmt.body[0] | ||
| if not isinstance(expr, cst.Expr): | ||
| return tree | ||
| if not isinstance(expr.value, cst.SimpleString): | ||
| return tree | ||
| new_body = tree.body[1:] | ||
| return tree.with_changes(body=new_body) |
File renamed without changes.
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be
ClearDocstring?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it should be ClearDocstring, I'm sorry for the mixup