Skip to content

Include a py.typed marker file with the Python client #100

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

Open
isomorpheme wants to merge 1 commit into
base: master
Choose a base branch
from
+2 −1
Open

Include a py.typed marker file with the Python client #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 libs/opsqueue_python/opsqueue_python.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ let
};

# Full set of files to build the Python wheel on top
pythonFileFilter = path: _type: builtins.match "^.*\.(py|md)$" path != null;
pythonFileFilter = path: _type: builtins.match "^.*(py.typed|\.(py|md))$" path != null;
wheelFileFilter = path: type: (pythonFileFilter path type) || (rustCrateFileFilter path type);
wheelSrc = lib.cleanSourceWith {
src = ../../.;
Expand Down
1 change: 1 addition & 0 deletions libs/opsqueue_python/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Issues="https://github.com/channable/opsqueue/issues"
features = ["pyo3/extension-module"]
python-source = "python"
module-name = "opsqueue.opsqueue_internal"
include = ["**/py.typed"]
Copy link
Copy Markdown
Contributor Author

@isomorpheme isomorpheme Apr 24, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

I don't know how to check if this does what I expect it to; I don't know how to inspect the results of just build-python. Would appreciate pointers!

Copy link
Copy Markdown
Contributor

@Qqwy Qqwy Apr 24, 2026

Choose a reason for hiding this comment

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

Does this section of the README help?

Copy link
Copy Markdown
Contributor Author

@isomorpheme isomorpheme Apr 24, 2026

Choose a reason for hiding this comment

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

It didn't per se, but I figured it out: just build-python builds a wheel in /tmp and cleans it up before finishing, so instead I used maturin build which outputs it locally. It turns out that .whl files are secretly just zip archives, so I checked and the py.typed is indeed included. 🎉


# We specify test-dependencies here (and have them loaded through `.setup_local_venv.sh`)
# because otherwise `pytest` won't be able to see the locally build python package!
Expand Down
Empty file added libs/opsqueue_python/python/opsqueue/py.typed
View file
Open in desktop
Empty file.
Loading