Skip to content
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

Fix Literal parse error in RemoveImportsVisitor #1130

Merged
merged 1 commit into from
May 3, 2024

Conversation

camillol
Copy link
Contributor

@camillol camillol commented Apr 6, 2024

GatherNamesFromStringAnnotationsVisitor, which is called by GatherUnusedImportsVisitor, which is called by RemoveImportsVisitor, attempts to parse any string contained in an annotation as if it were Python code. This behavior was added in #353 with the goal of parsing type names wrapped in strings.

However, not all strings occurring inside annotations can or should be interpreted that way. For example:

from typing import Literal

a: Literal["in"]
b: list[Literal["1x"]]
c: Literal["Any"]

a and b will cause a ParserSyntaxError, while c will be incorrectly treated as a mention of the symbol Any.

This PR makes two changes to GatherNamesFromStringAnnotationsVisitor:

  • Anything inside a Literal is ignored.
    • This fixes all of the above examples.
  • Failures to parse a string inside an annotation as Python code are simply ignored.
    • This will take care of any other usages of non-code strings inside an annotation.

Fixes:

@facebook-github-bot
Copy link

Hi @camillol!

Thank you for your pull request and welcome to our community.

Action Required

In 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.

Process

In 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 CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Apr 8, 2024
@zsol
Copy link
Member

zsol commented May 3, 2024

Thank you!

@zsol zsol merged commit 82f804a into Instagram:main May 3, 2024
20 of 21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants