Why tarfile.TarFile.gzopen is not in the online documentation?

Baptiste Lepilleur baptiste.lepilleur at gmail.com
Wed Feb 24 09:37:19 CET 2010


I stumbled uppon this and find it somewhat odd: some class methods of
TarFile and TarInfo do not appears in either the online documentation or
search while they have a doc string:

http://docs.python.org/search.html?q=gzopen
http://docs.python.org/library/tarfile.html?highlight=tarfile#tarfile.TarFile

See script at the end for list of class methods.

Is this "by design" or is there some an odd bug in doc generation lurking
around? This somehow seem to be specific to module tarfile. Fraction
classmethod from_float() is available in the documentation and found by a
search for example...

---
Python 2.6.2 (r262:71605, Apr 14 2009, 22:40:02) [MSC v.1500 32 bit (Intel)]
on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import tarfile
>>> help( tarfile.TarFile.gzopen )
Help on method gzopen in module tarfile:

gzopen(cls, name, mode='r', fileobj=None, compresslevel=9, **kwargs) method
of __builtin__.type instance
    Open gzip compressed tar archive name for reading or writing.
    Appending is not allowed.

>>> help( tarfile.TarFile.bz2open )
Help on method bz2open in module tarfile:

bz2open(cls, name, mode='r', fileobj=None, compresslevel=9, **kwargs) method
of __builtin__.type instance
    Open bzip2 compressed tar archive name for reading or writing.
    Appending is not allowed.

>>> help( tarfile.TarInfo.create_pax_global_header )
Help on method create_pax_global_header in module tarfile:

create_pax_global_header(cls, pax_headers) method of __builtin__.type
instance
    Return the object as a pax global header block sequence.

Baptiste.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-list/attachments/20100224/9f3f9833/attachment.html>


More information about the Python-list mailing list