Refactor: Add explicit TypeAlias for VoiceStreamEvent using modern Py… #297
Conversation
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
…thon typing |Update events.py
This PR improves type hint clarity and consistency by defining `VoiceStreamEvent` as an explicit `TypeAlias` using Python 3.10+ syntax.
### 🔧 What was changed:
```python
VoiceStreamEvent: TypeAlias = (
VoiceStreamEventAudio | VoiceStreamEventLifecycle | VoiceStreamEventError
)
```
### 🧠 Why:
- ✅ **Explicit Type Alias**: Clearly indicates that `VoiceStreamEvent` is a type alias, not a runtime variable (per [PEP 613](https://peps.python.org/pep-0613/)).
- ✅ **Improved Readability**: Uses the modern `|` union syntax, which is more concise and readable than `Union[...]`.
- ✅ **Better Tooling Support**: Helps static type checkers (like MyPy and Pyright) understand developer intent, improving accuracy and IDE support.
### 📌 Note:
This change does not affect runtime behavior. It purely enhances type safety and code quality for developers and static analyzers.
|
We can't use some of this stuff because the repo is 3.9+. Btw I've noticed a lot of PRs from you - appreciate the effort, but not all of them are aligned with the requirements of this repo (eg this one breaks 3.9 compat). It might make sense to open issues first, and focus on ones that have broad value! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
…thon typing |Update events.py
This PR improves type hint clarity and consistency by defining
VoiceStreamEventas an explicitTypeAliasusing Python 3.10+ syntax.🔧 What was changed:
🧠 Why:
VoiceStreamEventis a type alias, not a runtime variable (per PEP 613).|union syntax, which is more concise and readable thanUnion[...].📌 Note:
This change does not affect runtime behavior. It purely enhances type safety and code quality for developers and static analyzers.