gettarinfo method does not handle files without text string names #66195

Activity

1. vadmium commented on Jul 17, 2014

   

   vadmium

   on Jul 17, 2014

   MemberAuthor

   More actions

   It looks like if you pass a “fileobj” argument to “gettarinfo”, it assumes it can use the “name” as a text string.

   >>> import tarfile
   >>> with tarfile.open("/dev/null", "w") as tar, open("/bin/sh", "rb") as file: tar.gettarinfo(fileobj=file)
   ... 
   <TarInfo 'bin/sh' at 0x7f13cc937f20>
   >>> with tarfile.open("/dev/null", "w") as tar, open(b"/bin/sh", "rb") as file: tar.gettarinfo(fileobj=file)
   ... 
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
     File "/media/disk/home/proj/python/cpython/Lib/tarfile.py", line 1767, in gettarinfo
       arcname = arcname.replace(os.sep, "/")
   TypeError: expected bytes, bytearray or buffer compatible object
   >>> with tarfile.open("/dev/null", "w") as tar, open(0, "rb", closefd=False) as file: tar.gettarinfo(fileobj=file)
   ... 
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
     File "/media/disk/home/proj/python/cpython/Lib/tarfile.py", line 1766, in gettarinfo
       drv, arcname = os.path.splitdrive(arcname)
     File "Lib/posixpath.py", line 133, in splitdrive
       return p[:0], p
   TypeError: 'int' object is not subscriptable

   In my case, my code always sets the final TarInfo.name attribute later on, so the initial name does not matter. Perhaps at least the documentation should say that “fileobj.name” must be a real unencoded file name string unless “arcname” is also given. My workaround was to add a dummy arcname argument, a bit like this:

   # Explicit dummy name to avoid using file name of bytes
   tarinfo = self.tar.gettarinfo(fileobj=file, arcname="")
   # . . .
   tarinfo.name = "{}/{}".format(self.pkgname, name)
2. vadmium

   added

   stdlibStandard Library Python modules in the Lib/ directoryStandard Library Python modules in the Lib/ directory

   on Jul 17, 2014
3. bitdancer commented on Jul 19, 2014

   

   bitdancer

   on Jul 19, 2014

   Member

   More actions

   Agreed, the documentation should be modified to say "(using os.fstat on its file descriptor, and its 'name' attribute if arcname is not specified").
4. bitdancer

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   on Jul 19, 2014
5. bitdancer

   assigned

   docspython

   on Jul 19, 2014
6. vadmium commented on Apr 20, 2015

   

   vadmium

   on Apr 20, 2015

   MemberAuthor

   More actions

   Over in bpo-22468, I posted a documentation patch which includes wording to address this bug.
7. python-dev commented on Feb 20, 2016

   

   python-devmannequin

   on Feb 20, 2016

   Mannequin

   More actions

   New changeset 94a94deaf06a by Martin Panter in branch '3.5':
   Issues bpo-22468, bpo-21996, bpo-22208: Clarify gettarinfo() and TarInfo usage
   https://hg.python.org/cpython/rev/94a94deaf06a

   New changeset 9d5217aaea13 by Martin Panter in branch '2.7':
   Issues bpo-22468, bpo-21996, bpo-22208: Clarify gettarinfo() and TarInfo usage
   https://hg.python.org/cpython/rev/9d5217aaea13
8. vadmium

   closed this as completedon Feb 20, 2016
9. ezio-melotti

   transferred this issue fromon Apr 10, 2022