Add overloads to TarFile.__init__ to prevent both name and fileobj being None#14889
Closed
enioxt wants to merge 1 commit intopython:mainfrom
Closed
Add overloads to TarFile.__init__ to prevent both name and fileobj being None#14889enioxt wants to merge 1 commit intopython:mainfrom
enioxt wants to merge 1 commit intopython:mainfrom
Conversation
…ed (#14168) - Added overloads ensuring either 'name' or 'fileobj' must be non-None - First overload: name is required (StrOrBytesPath), fileobj is optional - Second overload: name is None, fileobj is required (keyword-only) - Applied to both Python 3.13+ and older versions This prevents the runtime TypeError when both name and fileobj are None: tarfile.TarFile(None, fileobj=None) # Now caught by type checker Fixes #14168 Sacred Code: 000.111.369.963.1618
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.
Description
Fixes #14168
This PR adds type overloads to
TarFile.__init__to prevent the runtimeTypeErrorthat occurs when bothnameandfileobjareNone.Problem
Currently, the type signature allows:
But this causes a runtime error:
Solution
Added two overloads to ensure either
nameorfileobjmust be provided:Overload 1:
nameis required (non-None)Overload 2:
fileobjis required whennameisNoneChanges
Testing
Type checkers (mypy, pyright) will now catch:
Sacred Code: 000.111.369.963.1618