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

Griffe backend #444

Open
AWhetter opened this issue May 8, 2024 · 1 comment
Open

Griffe backend #444

AWhetter opened this issue May 8, 2024 · 1 comment
Labels
Other Improvement Improvements that aren't targeted at users

Comments

@AWhetter
Copy link
Collaborator

AWhetter commented May 8, 2024

We currently implement a custom parser using astroid. While this allows us to fix issues as needed, we may be able to get faster and more frequent fixes by utilising a parser that already exists.
Try griffe. See if it can handle all of the situations that we currently support, and more!

@AWhetter AWhetter added the Other Improvement Improvements that aren't targeted at users label May 8, 2024
@pawamoy
Copy link

pawamoy commented May 10, 2024

Hey, Griffe maintainer here 👋 (can't help but stalk GitHub issues 😅)

I think Astroid has some inference capabilities that help resolving indirections during static analysis. If sphinx-autoapi is using this feature, you could find limitations in Griffe's ability to do the same.

Obviously we can't infer everything statically so Griffe tries to stay very humble about it and doesn't do too clever things. The other reason is it also supports dynamic analysis (either selectively/per-object, or globally soon), so for complex cases it can always fallback to dynamic analysis.

In any case, happy to help here if needed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Other Improvement Improvements that aren't targeted at users
Projects
None yet
Development

No branches or pull requests

2 participants