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
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
refactor: generate griffe import stubs
machow committed Feb 19, 2025
commit 5a6af0148886b2e9bcc6ef1290cae97e6b5671e8
22 changes: 0 additions & 22 deletions quartodoc/_griffe_compat.py

This file was deleted.

10 changes: 8 additions & 2 deletions quartodoc/_griffe_compat/_generate_stubs.py
Original file line number Diff line number Diff line change
@@ -44,7 +44,9 @@ def code_for_imports(mod_code: str, submodules: list[str]) -> str:
new_expr.module = "griffe"
res.append(ast.unparse(new_expr))

return black.format_str("\n".join(res), mode=black.FileMode())
return black.format_str(
"# flake8: noqa\n\n" + "\n".join(res), mode=black.FileMode()
)


def generate_griffe_stub(out_path: Path, mod, submodules: list[str]):
@@ -53,7 +55,11 @@ def generate_griffe_stub(out_path: Path, mod, submodules: list[str]):


MAPPINGS = {
"dataclasses": ["_griffe.models", "_griffe.mixins", "_griffe.enumerations"],
"dataclasses": [
"_griffe.models",
"_griffe.mixins",
"_griffe.enumerations",
],
"docstrings": ["_griffe.docstrings.models"],
"expressions": ["_griffe.expressions"],
}
31 changes: 31 additions & 0 deletions quartodoc/_griffe_compat/dataclasses.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# flake8: noqa

from griffe import (
Alias,
Attribute,
Class,
Decorator,
Docstring,
Function,
Module,
Object,
Parameter,
Parameters,
)
from griffe import (
DelMembersMixin,
GetMembersMixin,
ObjectAliasMixin,
SerializationMixin,
SetMembersMixin,
)
from griffe import (
BreakageKind,
DocstringSectionKind,
ExplanationStyle,
Kind,
LogLevel,
ObjectKind,
ParameterKind,
Parser,
)
34 changes: 34 additions & 0 deletions quartodoc/_griffe_compat/docstrings.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# flake8: noqa

from griffe import (
DocstringAdmonition,
DocstringAttribute,
DocstringClass,
DocstringDeprecated,
DocstringElement,
DocstringFunction,
DocstringModule,
DocstringNamedElement,
DocstringParameter,
DocstringRaise,
DocstringReceive,
DocstringReturn,
DocstringSection,
DocstringSectionAdmonition,
DocstringSectionAttributes,
DocstringSectionClasses,
DocstringSectionDeprecated,
DocstringSectionExamples,
DocstringSectionFunctions,
DocstringSectionModules,
DocstringSectionOtherParameters,
DocstringSectionParameters,
DocstringSectionRaises,
DocstringSectionReceives,
DocstringSectionReturns,
DocstringSectionText,
DocstringSectionWarns,
DocstringSectionYields,
DocstringWarn,
DocstringYield,
)
44 changes: 44 additions & 0 deletions quartodoc/_griffe_compat/expressions.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# flake8: noqa

from griffe import (
Expr,
ExprAttribute,
ExprBinOp,
ExprBoolOp,
ExprCall,
ExprCompare,
ExprComprehension,
ExprConstant,
ExprDict,
ExprDictComp,
ExprExtSlice,
ExprFormatted,
ExprGeneratorExp,
ExprIfExp,
ExprJoinedStr,
ExprKeyword,
ExprLambda,
ExprList,
ExprListComp,
ExprName,
ExprNamedExpr,
ExprParameter,
ExprSet,
ExprSetComp,
ExprSlice,
ExprSubscript,
ExprTuple,
ExprUnaryOp,
ExprVarKeyword,
ExprVarPositional,
ExprYield,
ExprYieldFrom,
get_annotation,
get_base_class,
get_condition,
get_expression,
safe_get_annotation,
safe_get_base_class,
safe_get_condition,
safe_get_expression,
)