Skip to content

doc db to include types.* #6391

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

Merged
youknowone merged 3 commits into from
Dec 10, 2025
Merged

doc db to include types.* #6391

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3d0b809
Add types.* for doc/generate.py
youknowone Dec 10, 2025
2a16d63
udpate-doc-db workflow
youknowone Dec 10, 2025
b2367ac
Update doc DB for CPython 3.13.9
github-actions[bot] Dec 10, 2025
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
Next Next commit
Add types.* for doc/generate.py
  • Loading branch information
@youknowone
youknowone committed Dec 10, 2025
commit 3d0b809d2f3c1aed3318843a87d8120cc718d258
11 changes: 10 additions & 1 deletion crates/doc/generate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,15 @@ def find_doc_entries() -> "Iterable[DocEntry]":
type(str().__iter__()),
type(tuple().__iter__()),
]

# Add types from the types module (e.g., ModuleType, FunctionType, etc.)
for name in dir(types):
if name.startswith("_"):
continue
obj = getattr(types, name)
if isinstance(obj, type):
builtin_types.append(obj)

for typ in builtin_types:
parts = ("builtins", typ.__name__)
yield DocEntry(parts, pydoc._getowndoc(typ))
Expand All @@ -204,7 +213,7 @@ def main():
docs = {
entry.key: entry.doc
for entry in find_doc_entries()
if entry.raw_doc is not None
if entry.raw_doc is not None and isinstance(entry.raw_doc, str)
}
dumped = json.dumps(docs, sort_keys=True, indent=4)
OUTPUT_FILE.write_text(dumped)
Expand Down