Skip to content

Add PEP 561 Type Hints Support#27

Merged
abersheeran merged 1 commit intofishaudio:mainfrom
ywkim:feat/add-pep561-type-hints
Oct 18, 2025
Merged

Add PEP 561 Type Hints Support#27
abersheeran merged 1 commit intofishaudio:mainfrom
ywkim:feat/add-pep561-type-hints

Conversation

@ywkim
Copy link
Copy Markdown
Contributor

@ywkim ywkim commented Oct 17, 2025

This PR adds a py.typed marker file to enable type checking support for downstream projects using mypy and other type checkers, as specified in PEP 561.

Problem

The fish-audio-sdk package contains comprehensive type annotations (using Pydantic models and type hints throughout), but without a py.typed marker file, type checkers like mypy cannot utilize these annotations.

Solution

Added an empty py.typed file to src/fish_audio_sdk/ to indicate that this package supports type checking.

Changes

  • ✅ Added src/fish_audio_sdk/py.typed (empty marker file)

Benefits

  • Better type safety: Downstream projects can now get full type checking support
  • Improved developer experience: IDEs and type checkers can provide better autocomplete and error detection
  • Standards compliance: Follows PEP 561 standard for distributing type information

@abersheeran abersheeran merged commit a51d0b9 into fishaudio:main Oct 18, 2025
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