Update WorkflowContext to use Never as default type parameter instead of None #873
+0
−0
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.
This PR updates the
WorkflowContextclass to useNeveras the default value for its type parameter instead ofNone, aligning with Python typing best practices and making the intent clearer for type checkers.Changes Made
Core Type System Updates
T_Out = TypeVar("T_Out")toT_Out = TypeVar("T_Out", default=Never)in_workflow_context.pyfrom typing import Neverandfrom typing_extensions import TypeVarWorkflowContext[Never]instead ofWorkflowContext[None]Validation and Error Messages
WorkflowContext[Never]instead ofWorkflowContext[None]Nevertype while maintaining backward compatibility withNoneNeverinstead ofNoneFunction Executor Support
Neveralongside existingNonesupportWorkflowContext[Never]andWorkflowContext[None]now correctly infer empty output types ([])Example Usage
Before (still supported for backward compatibility):
After (recommended approach):
Why Never Instead of None?
In Python's type system,
Never(orNoReturn) is the appropriate type for contexts that never produce/emit values, whileNonerepresents the absence of a value. UsingNevermakes the intent clearer:Neversemantically indicates "this context will never emit messages"Backward Compatibility
This change maintains full backward compatibility:
WorkflowContext[None]continues to work without modificationNeverandNonetype parametersTesting
WorkflowContext[Never]validationNeveroutput type inference in function executorsNeverNeverin error messagesThis pull request was created as a result of the following prompt from Copilot chat.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.