Add DisallowedSpecialTokenError (ValueError subclass) for disallowed special tokens (#290) - #590
Open
JayYarlagadda wants to merge 1 commit into
Open
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
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.
Summary
This adds a dedicated
DisallowedSpecialTokenErrorfor the case whereencode()encounters text corresponding to a special token that was not allowed.The exception is exported from the top-level
tiktokenpackage, so callers can handle this specific condition without matching the existing error message:Why
Until now, this path raised a plain
ValueError. That made it difficult for callers to distinguish a disallowed special token from other invalid input without relying on the exception message.DisallowedSpecialTokenErrorsubclassesValueError, so existing code that catchesValueErrorcontinues to work unchanged. The message and detection behavior are also unchanged; only the concrete exception type is made more specific.Implementation
DisallowedSpecialTokenError(ValueError)intiktoken.core.raise_disallowed_special_token()helper, covering all current encode paths.tiktokenas part of the public API.ValueError.Validation
ValueError.Closes #290