Fix: Replace None with 0 in CompletionUsage Tokens Details #2030
+4
−4
Conversation
This file contains 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
This commit addresses the issue outlined in openai#1837 by replacing `None` with `0` for various token fields in the `CompletionTokensDetails` and `PromptTokensDetails` classes. These fields are intended to represent counters, so initializing them with `0` simplifies the code and eliminates unnecessary optional checks. **Changes made:** - Replaced `None` with `0` for fields like `audio_tokens`, `reasoning_tokens`, and `cached_tokens` in both `CompletionTokensDetails` and `PromptTokensDetails` classes. - This update makes the token fields more consistent and eliminates the need for optional handling, as they will always default to `0` if not specified. **Why `Optional` was not removed:** - The `Optional` typing has been retained for some fields (like `audio_tokens` and `reasoning_tokens`) because, in some cases, the presence of these tokens may depend on certain conditions. By leaving them as `Optional`, we ensure flexibility in cases where the tokens might not be relevant or provided (e.g., for specific models or types of requests). This update improves usability by simplifying the tracking of token usage, avoiding unnecessary checks, and ensuring default values of `0` for all relevant counters.
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes being requested
This pull request addresses the issue raised in #1837 by replacing
Nonewith0in theCompletionTokensDetailsandPromptTokensDetailsclasses. The token fields, which represent counters, have been updated to use0as the default value instead ofNone. This eliminates unnecessary optional checks and simplifies the handling of token usage.Specific changes include:
Optional[int] = NonewithOptional[int] = 0for the following fields:audio_tokensreasoning_tokenscached_tokens0, making it easier to track usage without additional checks.Additional context & links
Nonevalues and ensuring all counters start at0by default.Optionaltype was not removed entirely, as some fields may still be conditionally populated depending on the request or model.