Skip to content

feat: Prefer stub over target object if not the same kind #422

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Prefer stub over target object if not the same kind #422

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 3 additions & 6 deletions src/griffe/_internal/merger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,9 @@ def _merge_stubs_members(obj: Module | Class, stubs: Module | Class) -> None:
# not the canonical one. Therefore, we must allow merging stubs into the target of an alias,
# as long as the stub and target are of the same kind.
if obj_member.kind is not stub_member.kind:
logger.debug(
"Cannot merge stubs for %s: kind %s != %s",
obj_member.path,
stub_member.kind.value,
obj_member.kind.value,
)
# If the stub and the target are not of the same kind, prefer the
# stub over the target.
obj.set_member(stub_member.name, stub_member)
elif obj_member.is_module:
_merge_module_stubs(obj_member, stub_member) # type: ignore[arg-type]
elif obj_member.is_class:
Expand Down