Fix using report() with a Module visitor #368
Conversation
|
Hi @duzumaki! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
duzumaki
force-pushed
the
fix_mode_comment_yielding_in_report
branch
2 times, most recently
from
e548a07
to
7b2f33e
Compare
Currently in fixit v2.0.0.post1
calling self.report() in a Module node visitor like so:
```
def visit_Module(self, node: cst.Module) -> None:
self.report(node)
```
resulted in a libcst error where the module node was passed into
self.get_metadata like so:
```
self.get_metadata(ParentNodeProvider, node)
```
I am assuing this fails intentionally in libcst because what is the parent of a module?
Nothing.
It results in this error:
```
python3.10/site-packages/fixit/rule.py:151: in node_comments
parent = self.get_metadata(ParentNodeProvider, node)
python3.10/site-packages/libcst/_metadata_dependent.py:136: in get_metadata
value = self.metadata[key][node]
E KeyError: Module(
E body=[
E SimpleStatem
-the rest of the error is just the rest of the module tree-
```
This PR aims to fix that by yielding any comments that exist in
a module's header(which is the current intention of fixit)
and if the current visitor is not a module node
it will check its parent with the ParentNodeProvider like it already does.
duzumaki
force-pushed
the
fix_mode_comment_yielding_in_report
branch
from
7b2f33e
to
7fe4bb3
Compare
facebook-github-bot
added
the
CLA Signed
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
|
Thank you for spotting and fixing this! 🥂 |
Currently in
fixit v2.0.0.post1calling
self.report()in aModulenode visitor like so:resulted in a libcst error where the module node was passed into
self.get_metadata:I am assuing this fails intentionally in libcst because what is the parent of a module?
Nothing.
It results in this error:
This PR aims to fix that by yielding any comments that exist in
a
module'sheader(which is the intention of thenode_commentsfunction for header comments)and if the current visitor is not a
modulenodeit will check its parent with the
ParentNodeProviderlike it already does.fixes: #367