Skip to content

Add public API typing stubs#12

Merged
aviadr1 merged 1 commit into
mainfrom
codex/add-public-api-stubs
Apr 25, 2026
Merged

Add public API typing stubs#12
aviadr1 merged 1 commit into
mainfrom
codex/add-public-api-stubs

Conversation

@aviadr1

@aviadr1 aviadr1 commented Apr 25, 2026

Copy link
Copy Markdown
Owner

Summary

  • extract the useful typing/API ergonomics idea from PR Add better portability to uvloop and winloop #1 into the modernized src-layout package
  • add a public init.pyi stub while keeping runtime names as direct backend aliases
  • document typing behavior and bump version to 0.2.2

Why a .pyi stub instead of runtime Protocol/ABC wrappers

The runtime objects are intentionally direct aliases to uvloop or winloop objects. A .pyi stub improves editor and type-checker behavior without introducing wrapper classes that could alter identity checks or backend behavior.

Validation

  • uv lock --check
  • uv run ruff check .
  • uv run pytest
  • uv build
  • uv run twine check dist/*
  • verified the wheel contains winuvloop/init.pyi and winuvloop/py.typed

Closes #1

@aviadr1 aviadr1 merged commit 0438c0a into main Apr 25, 2026
7 checks passed
@aviadr1 aviadr1 deleted the codex/add-public-api-stubs branch April 25, 2026 14:55
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.

1 participant