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

refactor: make _griffe_compat a submodule that generates import stubs #393

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

machow
Copy link
Owner

@machow machow commented Feb 19, 2025

This PR removes the use of the internal _griffe module (#387). It's a little bit funky, but as a way of maintaining a tighter scope on imports--compared to using the full top-level griffe module--I just generated submodules importing the subsets of griffe I was using before.

It's not pretty, but it's helpful for giving me a quick hint on how quartodoc modules separate concerns (or dispatch on certain pieces, e.g. by looking for the dc. prefix)

Main pieces:

  • running python -m quartodoc._griffe_compat._generate_stubs creates the 3 submodules (e.g. dataclasses.py)

@codecov-commenter
Copy link

codecov-commenter commented Feb 19, 2025

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.80%. Comparing base (ee4fa3c) to head (1d5077e).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #393      +/-   ##
==========================================
+ Coverage   88.78%   88.80%   +0.02%     
==========================================
  Files          37       40       +3     
  Lines        3004     3010       +6     
==========================================
+ Hits         2667     2673       +6     
  Misses        337      337              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants