Skip to content

Report every generated __text_signature__, and keep it out of __doc__ #8614

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 7 commits into from
Aug 31, 2026
Merged

Report every generated __text_signature__, and keep it out of __doc__ #8614

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7f5ba4c
Strip the signature prefix from builtin __doc__
leehanjeong Aug 29, 2026
80dff4e
Terminate a generated __text_signature__ that carries no documentation
leehanjeong Aug 29, 2026
5b3228d
Report a __text_signature__ for every method
leehanjeong Aug 29, 2026
030ae95
Drop the expectedFailure on test_simple_completion
leehanjeong Aug 30, 2026
e52a916
Name every #[pymethod] receiver zelf
leehanjeong Aug 30, 2026
3dc56a1
Drop the unreachable zelf name check in func_sig
leehanjeong Aug 30, 2026
5d4257b
Keep the argument bundle when marking the receiver
leehanjeong Aug 30, 2026
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
Terminate a generated __text_signature__ that carries no documentation 
A signature and its documentation share one string, separated by
`\n--\n\n`, and readers find the signature by searching for that marker.
A #[pyfunction] with no doc comment stored the bare signature, which no
reader could parse:

    >>> time.clock_getres.__doc__
    'clock_getres(clk_id, /)'
    >>> time.clock_getres.__text_signature__
    None

Emit the marker in that case too, as Argument Clinic does for an
undocumented function. 136 of the 915 functions reachable from the
importable modules were affected.

__doc__ now reports None for them, matching CPython, because nothing
follows the marker.

Assisted-by: Claude Code:claude-opus-5
  • Loading branch information
@leehanjeong
leehanjeong committed Aug 29, 2026
commit 80dff4eb1c18aa9ce87ae52c790f93b225c48e5f
2 changes: 1 addition & 1 deletion crates/derive-impl/src/pymodule.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -675,7 +675,7 @@ impl ModuleItem for FunctionItem {
});
let doc = match (sig_doc, doc) {
(Some(sig_doc), Some(doc)) => Some(format_doc(&sig_doc, &doc)),
(Some(sig_doc), None) => Some(sig_doc),
(Some(sig_doc), None) => Some(format_doc(&sig_doc, "")),
(None, doc) => doc,
};

Expand Down
6 changes: 6 additions & 0 deletions extra_tests/snippets/builtin_signature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import inspect
import os
import sys

# __text_signature__ is generated from the Rust parameter list, so it must not
Expand Down Expand Up @@ -47,6 +48,11 @@
assert str(inspect.signature(issubclass)) == "(cls, class_or_tuple, /)"
assert str(inspect.signature(aiter)) == "(async_iterable, /)"

# A generated signature is stored in __doc__ and read back out of it, so it
# needs the `--` terminator even when the function has no documentation.
assert str(inspect.signature(os.getpid)) == "()"
assert str(inspect.signature(os.getcwd)) == "()"

if sys.implementation.name == "rustpython":
# Functions whose Rust arguments are destructuring patterns rather than
# plain names get no signature at all, instead of emitting text that is not
Expand Down