Change return type from list[str] to list[dict]#238
Open
ZhengWentong wants to merge 3 commits into
Open
Conversation
The function actually returns a list of dictionaries, but the type annotation was list[str]. This change aligns the annotation with the actual return value.
I noticed that the return type could potentially be made more precise as well.
Currently the function returns objects with a fixed structure:
```python
class GenerateOutput(TypedDict):
text: str
token_ids: list[int]
def generate(...) -> list[GenerateOutput]:
```
Using `TypedDict` may provide better type safety and IDE support compared with `list[dict]`. The current change focuses only on correcting the existing type annotation, but I thought this could be a useful improvement.
Add TypedDict for GenerateOutput in llm_engine.py
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
1 participant
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.
The function actually returns a list of dictionaries, but the type annotation was list[str]. This change aligns the annotation with the actual return value.