Merged
Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
7c4575e to
910521b
Compare
cclauss
reviewed
Nov 28, 2025
There was a problem hiding this comment.
Pull request overview
This PR enhances type checking support for the tokenizers library by improving stub file generation and adding comprehensive type annotations. It supersedes PR #1865 with a more complete solution for static type checking.
Key Changes:
- Enhanced
stub.pyto generate better type stubs with property setters, magic methods, and improved signature handling - Updated PyO3 Rust bindings with explicit
text_signatureannotations for better Python type visibility - Added type ignore comments throughout test and example files to suppress expected type checker warnings
- Introduced type checking workflow integration (using "ty" tool)
Reviewed changes
Copilot reviewed 35 out of 35 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
bindings/python/stub.py |
Major refactoring: added OVERRIDES dict, improved signature extraction, property setter generation, and better error handling for ruff formatting |
bindings/python/src/*.rs |
Added/updated text_signature attributes on PyO3 constructors and methods to expose proper signatures to Python type checkers |
bindings/python/py_src/**/*.pyi |
Generated stub files with complete property setters, magic methods (__getstate__, __setstate__, __getitem__, etc.), and improved type hints |
bindings/python/tests/**/*.py |
Added # type: ignore comments for intentional type violations in tests (e.g., testing error handling with invalid inputs) |
bindings/python/scripts/*.py |
Added # type: ignore[import] for optional/external dependencies like sentencepiece, transformers, jieba, tiktoken |
bindings/python/pyproject.toml |
Added "ty" to testing dependencies, removed deprecated black configuration |
bindings/python/Makefile |
Integrated "ty check" commands into style checking targets |
.github/workflows/python.yml |
Added type checking step in CI workflow |
bindings/python/docs/pyo3.md |
New documentation explaining PyO3 usage patterns for Python bindings |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
McPatate
reviewed
Dec 1, 2025
Member
McPatate
left a comment
There was a problem hiding this comment.
Whatever is going on in stub.py I trust that you know what you're doing and that it works as intended lol
bindings/python/py_src/tokenizers/implementations/sentencepiece_unigram.py
Show resolved
Hide resolved
bindings/python/py_src/tokenizers/implementations/sentencepiece_unigram.py
Show resolved
Hide resolved
McPatate
approved these changes
Dec 2, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updater stub for better typing.
Superseed #1865!
Really not a typing pro, if anyone wants to make it better you can submit a PR, this is a quick fix IMO