Fix NameError in serving CLI due to conditional import asymmetry#45641
Closed
abhiprd200 wants to merge 6 commits intohuggingface:mainfrom
Closed
Fix NameError in serving CLI due to conditional import asymmetry#45641abhiprd200 wants to merge 6 commits intohuggingface:mainfrom
abhiprd200 wants to merge 6 commits intohuggingface:mainfrom
Conversation
The serving module conditionally imports OpenAI types behind is_serve_available(), but unconditionally inherits from them in the global scope. This causes a fatal NameError when the server boots without the serving extras installed. This patch provides dummy fallback types to allow the CLI classes to initialize safely.
The serving module conditionally imports OpenAI types behind is_serve_available(), but unconditionally inherits from them in the global scope. This causes a fatal NameError when the server boots without the serving extras installed. This patch provides dummy fallback types to allow the CLI classes to initialize safely.
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
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.
What does this PR do?
Fixes a fatal crash in the
transformers serveCLI when booting without the[serving]extras installed.The Bug
Files in
src/transformers/cli/serving/(such aschat_completion.pyandcompletion.py) conditionally import OpenAI types behind theis_serve_available()check. However, they unconditionally inherit from these types in the global scope (e.g.,class TransformersCompletionCreateParamsStreaming(CompletionCreateParamsStreaming)).When a user's environment fails
is_serve_available(), the base classes are not imported, triggering an immediateNameErrorthat cascades through the serving handlers and crashes the CLI.The Fix
Enforced symmetry by providing
TypedDictordict-based dummy fallback classes in theexcept ImportError(orelse) blocks. This allows the child classes to safely compile into memory globally, preventing theNameErrorand allowing the server to boot and gracefully handle requests or prompt the user for the correct dependencies.Files Modified
chat_completion.pycompletion.pyresponse.pytranscription.py