classification
Title: Misleading AttributeError accessing fileno attribute in tarfile
Type: behavior Stage: patch review
Components: Library (Lib) Versions: Python 3.9
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: Claudiu.Popa, ZackerySpytz, lars.gustaebel, serhiy.storchaka, xtreak
Priority: normal Keywords: patch

Created on 2019-10-24 06:55 by xtreak, last changed 2020-09-09 20:27 by ZackerySpytz.

Pull Requests
URL Status Linked Edit
PR 17449 closed Claudiu.Popa, 2019-12-03 11:04
PR 22178 open ZackerySpytz, 2020-09-09 20:27
Messages (2)
msg355283 - (view) Author: Karthikeyan Singaravelan (xtreak) * (Python committer) Date: 2019-10-24 06:55
This came up during https://github.com/psf/requests/issues/5229 . While fileno returns True as an attribute the actual implementation uses self.raw.fileno where the AttributeError is raised at https://github.com/python/cpython/blob/96b06aefe23521b61e4e9cdd44f5d30b00c7eb95/Lib/_pyio.py#L878 (Python implementation) . I guess it should be raising UnsupportedOperation when self.raw has no fileno so that the callers only need to catch UnsupportedOperation. Something like below for fileno implementation that will give a better exception.

   def fileno(self):
        if hasattr(self.raw, 'fileno'):
            return self.raw.fileno()
        else:
            self._unsupported("fileno")

# tarfile_fileno.py

import tarfile
import os

for f in ["foo.txt", "foo.tar"]:
    try:
        os.unlink(f)
    except OSError:
        pass

with open("foo.txt", "w") as f:
    f.write("foo.txt")
    with tarfile.open("foo.tar", "w:gz") as tarfile_obj:
        tarfile_obj.add(f.name)

with tarfile.open("foo.tar", "r:gz") as f:
    member = f.extractfile("foo.txt")
    print(f"Has attr : {hasattr(member, 'fileno')}")
    print(member.fileno())

# Current exception

python.exe .\tarfile_fileno.py
Has attr : True
Traceback (most recent call last):
  File ".\tarfile_fileno.py", line 18, in <module>
    print(member.fileno())
AttributeError: '_FileInFile' object has no attribute 'fileno'

# Proposed exception (Patching tarfile to use _pyio and modifying fileno as above) 

python.exe .\tarfile_fileno.py
Has attr : True
Traceback (most recent call last):
  File ".\tarfile_fileno.py", line 11, in <module>
    print(member.fileno())
  File "C:\Users\kasingar\AppData\Local\Programs\Python\Python37-32\lib\_pyio.py", line 831, in fileno
    self._unsupported("fileno")
  File "C:\Users\kasingar\AppData\Local\Programs\Python\Python37-32\lib\_pyio.py", line 320, in _unsupported
    (self.__class__.__name__, name))
io.UnsupportedOperation: ExFileObject.fileno() not supported
msg357749 - (view) Author: PCManticore (Claudiu.Popa) * (Python triager) Date: 2019-12-03 11:05
Just submitted a PR for this issue, hope I got it right. Curious to see if there are any backwards compatibility concerns with this approach.
History
Date User Action Args
2020-09-09 20:27:43ZackerySpytzsetnosy: + ZackerySpytz
pull_requests: + pull_request21244
2019-12-03 11:05:44Claudiu.Popasetmessages: + msg357749
2019-12-03 11:04:48Claudiu.Popasetkeywords: + patch
stage: patch review
pull_requests: + pull_request16930
2019-12-03 09:37:44Claudiu.Popasetnosy: + Claudiu.Popa
2019-10-24 06:55:32xtreakcreate