Skip to content

Improve __init__.pyi and _typing_utils.pyi typings - #1055

Merged
sobolevn merged 2 commits into
msgspec:mainfrom
sobolevn:improve-init-typing
Jun 12, 2026
Merged

sobolevn merged 2 commits into
msgspec:mainfrom
sobolevn:improve-init-typing

Conversation

@sobolevn

Copy link
Copy Markdown
Member

Multiple changes:

  1. Style: None must be the last item in a union
  2. Using Final for constants. It changes the inferce:

Before:

» mypy ex.py
ex.py:3: note: Revealed type is "msgspec.UnsetType"
Success: no issues found in 1 source file

After:

» mypy ex.py
ex.py:3: note: Revealed type is "Literal[msgspec.UnsetType.UNSET]?"
Success: no issues found in 1 source file
  1. Using TypeIs instead of TypeGuard, so we can better narrow in the negative case as well. This check is symmetric.
  2. Renaming T -> _T to remove type-checking name from possible imports.
  3. Fixing bases type, it can accept all types, not just structs

@sobolevn
sobolevn enabled auto-merge June 12, 2026 12:17
@sobolevn
sobolevn added this pull request to the merge queue Jun 12, 2026
Merged via the queue into msgspec:main with commit 619c98e Jun 12, 2026
11 checks passed
@sobolevn
sobolevn deleted the improve-init-typing branch June 12, 2026 12:18
pull Bot pushed a commit to Future-Outlier/msgspec that referenced this pull request Sep 14, 2026
Widening the runtime to accept `None` was the alternative. I rejected
it: the docstring specifies `offset : int, optional` and reserves `-1`
as the sentinel for writing at the end of the buffer, which leaves
`None` with no meaning to carry. Narrowing the stub makes the declared
type match both the C code and the documented contract.

The `int | None` traces back to the original `Optional[int]` annotation
and survived the 3.10+ syntax migration in msgspec#1041. Nothing in the tree
passes `None`.

Residual limitation: this edits the same two stub lines as open PR
msgspec#1160, which reshapes `buffer` and the return type while keeping
`offset: int | None`. Whichever lands second needs a one-line rebase.
The two changes are otherwise independent, since msgspec#1160 keeps reading
`offset` via `PyLong_AsSsize_t`.

Measurement, CPython 3.14:

- `just test-typing` clean under mypy 2.3.0, pyright 1.1.411, pyrefly
1.2.0.
- Reverting the stub hunk alone makes all three checkers fail on both
new call sites in `basic_typing_examples.py`, so the type-level test is
not vacuous.
- `pytest tests/unit`: 6119 passed, 404 skipped, identical to the
pre-change baseline. The two runtime assertions are pins on current
behavior rather than new coverage.
- `ruff format` collapses the signature onto one line once `| None` is
gone; that reformat is included.

No changelog entry, following merged stub PRs msgspec#1055, msgspec#1057, msgspec#1062,
msgspec#1065, msgspec#1074 and msgspec#1093, which leave it to the aggregated "type stub
improvements" line at release.

Co-authored-by: Dylan Pulver <dylanpulver@users.noreply.github.com>

This branch was successfully deployed

1 active deployment
docs-preview — e47c9cd8 Deployed Jun 12, 2026 by sobolevn via Deploy preview #40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants