Skip to content

Match codec and timer signature defaults to Python 3.15 #9741

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 2 commits into from
Nov 8, 2026
Merged

Match codec and timer signature defaults to Python 3.15 #9741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71982fe
Match codec and timer text signature defaults to Python 3.15
codex Nov 7, 2026
6e9cd8f
Ignore Clinic line wrapping in signature default assertion
codex Nov 7, 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
2 changes: 1 addition & 1 deletion crates/stdlib/src/binascii.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ mod decl {
data: ArgBytesLike,
#[pyarg(any, optional)]
sep: OptionalArg<PyObjectRef>,
#[pyarg(any, optional)]
#[pyarg(any, optional, py_default = "1")]
bytes_per_sep: OptionalArg<isize>,
}

Expand Down
8 changes: 4 additions & 4 deletions crates/stdlib/src/zlib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,8 +346,8 @@ mod zlib {
mem_level: ArgCInt,
#[pyarg(any, default = ::Z_DEFAULT_STRATEGY)]
strategy: ArgCInt,
// Missing dictionary is None.
#[pyarg(any, optional, py_default = "None")]
// Omission is distinct from an explicit None.
#[pyarg(any, optional)]
zdict: OptionalArg<ArgBytesLike>,
}

Expand Down Expand Up @@ -483,10 +483,10 @@ mod zlib {
}
}

// `decompressobj` shows MAX_WBITS. This constructor shows the integer.
// Keep the symbolic default used by CPython's Clinic signature.
#[derive(FromArgs)]
struct ZlibDecompressorArgs {
#[pyarg(any, default = ArgCInt::from(MAX_WBITS), py_default = "15")]
#[pyarg(any, default = ::MAX_WBITS)]
wbits: ArgCInt,
// Missing dictionary is empty bytes.
#[pyarg(any, optional, py_default = "b''")]
Expand Down
2 changes: 1 addition & 1 deletion crates/vm/src/stdlib/_signal.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ pub(crate) mod _signal {
which: i32,
#[pyarg(positional)]
seconds: PyObjectRef,
#[pyarg(positional, optional)]
#[pyarg(positional, optional, py_default = "0.0")]
interval: crate::function::OptionalArg<PyObjectRef>,
}

Expand Down
39 changes: 39 additions & 0 deletions extra_tests/snippets/builtin_signature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,42 @@
assert chmod_signature.startswith("($module, /, path, mode, *, dir_fd=None"), (
chmod_signature
)

# Omitted arguments keep their runtime sentinels while displaying CPython 3.15's
# public defaults. In particular, an omitted compression dictionary is not None.
import binascii
import signal
import zlib

for f in (binascii.hexlify, binascii.b2a_hex):
assert f.__text_signature__ == (
"($module, /, data, sep=<unrepresentable>, bytes_per_sep=1)"
)
assert f(b"abc", b":") == f(b"abc", b":", 1) == b"61:62:63"

if hasattr(signal, "setitimer"):
assert signal.setitimer.__text_signature__ == (
"($module, which, seconds, interval=0.0, /)"
)
assert inspect.signature(signal.setitimer).parameters["interval"].default == 0.0

assert " ".join(zlib.compressobj.__text_signature__.split()) == (
"($module, /, level=Z_DEFAULT_COMPRESSION, method=DEFLATED, "
"wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL, "
"strategy=Z_DEFAULT_STRATEGY, zdict=<unrepresentable>)"
)
try:
zlib.compressobj(zdict=None)
except TypeError:
pass
else:
raise AssertionError("None is not an omitted compression dictionary")

assert zlib._ZlibDecompressor.__text_signature__ == "(wbits=MAX_WBITS, zdict=b'')"
assert (
inspect.signature(zlib._ZlibDecompressor).parameters["wbits"].default
== zlib.MAX_WBITS
)
assert zlib._ZlibDecompressor().decompress(zlib.compress(b"signature defaults")) == (
b"signature defaults"
)
Comment on lines +112 to +114

@chatgpt-codex-connector chatgpt-codex-connector Bot Nov 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Avoid duplicating the existing zlib round-trip test

This round-trip assertion duplicates ZlibDecompressorTest.testDecompress in Lib/test/test_zlib.py:1051–1065: both compress bytes, construct _ZlibDecompressor() with its defaults, and verify the decompressed result. It adds no signature-specific coverage and violates AGENTS.md's explicit prohibition on adding snippet tests that duplicate Lib/test coverage. Keep the new signature assertions and rely on the existing standard-library test for runtime-default validation.

AGENTS.md reference: AGENTS.md:L119-L119

Useful? React with 👍 / 👎.

Loading