- 
          
- 
                Notifications
    You must be signed in to change notification settings 
- Fork 33.3k
gh-131492: gh-131461: handle exceptions in GzipFile constructor while owning resources #131462
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Merged
      
      
            vstinner
  merged 20 commits into
  python:main
from
graingert:fix-resource-warning-in-gzipfile-ctor
  
      
      
   
  Mar 20, 2025 
      
    
  
     Merged
                    Changes from 18 commits
      Commits
    
    
            Show all changes
          
          
            20 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      8abf17d
              
                gh-131461: fix ResourceWarning when writing a unwritable gzipfile
              
              
                graingert 1193e6c
              
                Merge branch 'main' into fix-resource-warning-in-gzipfile-ctor
              
              
                graingert 04f17ee
              
                remove redundant self.fileobj = None
              
              
                graingert 99d4a47
              
                Update Lib/gzip.py
              
              
                graingert 59ed512
              
                Update Lib/gzip.py
              
              
                graingert 2ac99bd
              
                📜🤖 Added by blurb_it.
              
              
                blurb-it[bot] 0a9c81b
              
                remember to raise
              
              
                graingert cef776c
              
                Update Misc/NEWS.d/next/Library/2025-03-19-14-36-54.gh-issue-131461.u…
              
              
                graingert 49f5a19
              
                Update Lib/gzip.py
              
              
                graingert d627689
              
                Update Lib/gzip.py
              
              
                graingert c9cdbf1
              
                assert no resource warning on tarfile failing to write on open
              
              
                graingert 2217713
              
                refactor gzip closing
              
              
                graingert 97ca4d3
              
                Update Lib/gzip.py
              
              
                graingert c9661e1
              
                Update Lib/gzip.py
              
              
                graingert 8e54c5b
              
                Update Lib/test/test_tarfile.py
              
              
                graingert 15a3058
              
                fix resource warning in GzipFile if anything in the ctor fails such a…
              
              
                graingert 8351549
              
                📜🤖 Added by blurb_it.
              
              
                blurb-it[bot] 7de109e
              
                Merge branch 'main' into fix-resource-warning-in-gzipfile-ctor
              
              
                graingert 052937f
              
                Update Misc/NEWS.d/next/Library/2025-03-20-08-32-49.gh-issue-131492.s…
              
              
                graingert 643a00d
              
                Update Misc/NEWS.d/next/Library/2025-03-20-08-32-49.gh-issue-131492.s…
              
              
                graingert File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      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
    
  
  
    
              
  
    
      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
    
  
  
    
              
        
          
          
            1 change: 1 addition & 0 deletions
          
          1 
        
  Misc/NEWS.d/next/Library/2025-03-19-14-36-54.gh-issue-131461.uDUmdY.rst
  
  
      
      
   
        
      
      
    
  
    
      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
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Fix :exc:`ResourceWarning` when constructing a :class:`gzip.GzipFile` in write mode with a broken file object. | 
        
          
          
            1 change: 1 addition & 0 deletions
          
          1 
        
  Misc/NEWS.d/next/Library/2025-03-20-08-32-49.gh-issue-131492.saC2cA.rst
  
  
      
      
   
        
      
      
    
  
    
      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
    
  
  
    
              
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Fix a resource leak when constructing a :class:`gzip.GzipFile` with a filename fails, for example when passing an invalid ``compresslevel`` | ||
|         
                  vstinner marked this conversation as resolved.
              Outdated
          
            Show resolved
            Hide resolved | ||
      
      Oops, something went wrong.
        
    
  
  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.
  
    
  
    
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I pushed a more thorough change inspired by
cpython/Lib/ssl.py
Lines 1014 to 1015 in a4832f6
previously it was possible for this self.myfileobj to be left open if any of the constructor failed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rather than the try/except wrapping, why not add a flag which is set to
Falseat the beginning of the constructor andTrueat the end, in__del__(which is what emits the resource warning), check that flag. If it's not fully constructed then don't emit the resource warning?The I/O stack (GzipFile inherits from IOBase) in
IOBase.__del__always does the close call ifself.closedis False, so shouldn't need to manually add a special case here. GzipFile.closed is:(so if there is a fileobj set, close should always be called).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This wouldn't help with myfileobj closing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about using
self.fileobj is not Noneas the "fully initialized" flag (already set to None always, only set to non-None at end of__init__), and checking aroundif self.filobj is None and self.myfileobj is not Nonein__del__?It feels a lot like this is adding more cases / code around closing. Trying to find a way to get this change to be smaller / more minimal to reduce risks. IO stack construction, dealloc warnings, and close + destruction order is already really intricate and hard to understand in full.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can't rely on
self.myfileobjbeing closed in__del__and we don't return an instance ofGzipFilefor the caller to close soself.myfileobjneeds to be closed at the end of__init__if there's an exception: so we need the try/catchThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right but this is closing objects that are inaccessible to the caller
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
GzipFile/selfis equally inaccessible, and cleaned up by its__del__/ finalizertp_finalize(ortp_dealloc). It's guaranteed__del__is called and able to release any held resources (such asself.myfileobj) see PEP-442.I'm okay adding a cleanup for the case where
self.fileobj is None and self.myfileobj is not Noneinside__del__. Matches the behavior of otherioobjects and is a lot smaller diff.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not correct, you cannot rely on
__del__to be called when an exception is raised because the exception traceback holds a reference to selfUh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That statement seems to contradict PEP 442 Predictability section to me...
Even if there is an exception traceback that keeps the reference to self, eventually that traceback will go out of scope and file will be closed / not leaked...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll defer to @vstinner and @serhiy-storchaka for approval. From my perspective, this is a lot more complex of a bugfix than required, didn't match stated description and arguments around
self.myfileobj. Happy to do quick fixes, can produce a much smaller patch here if desired with less behavior change.