# zipp - pydoc - phpman

Help on module zipp:

## NAME
    zipp - # coding: utf-8

## CLASSES
    builtins.object
        Path
        SanitizedNames

### class Path
     |  Path(root, at='')
     |
     |  A pathlib-compatible interface for zip files.
     |
     |  Consider a zip file with this structure::
     |
     |      .
     |      ├── a.txt
     |      └── b
     |          ├── c.txt
     |          └── d
     |              └── e.txt
     |
     |  >>> data = io.BytesIO()
     |  >>> zf = zipfile.ZipFile(data, 'w')
     |  >>> zf.writestr('a.txt', 'content of a')
     |  >>> zf.writestr('b/c.txt', 'content of c')
     |  >>> zf.writestr('b/d/e.txt', 'content of e')
     |  >>> zf.filename = 'abcde.zip'
     |
     |  Path accepts the zipfile object itself or a filename
     |
     |  >>> root = Path(zf)
     |
     |  From there, several path operations are available.
     |
     |  Directory iteration (including the zip file itself):
     |
     |  >>> a, b = root.iterdir()
     |  >>> a
     |  Path('abcde.zip', 'a.txt')
     |  >>> b
     |  Path('abcde.zip', 'b/')
     |
     |  name property:
     |
     |  >>> b.name
     |  'b'
     |
     |  join with divide operator:
     |
     |  >>> c = b / 'c.txt'
     |  >>> c
     |  Path('abcde.zip', 'b/c.txt')
     |  >>> c.name
     |  'c.txt'
     |
     |  Read text:
     |
     |  >>> c.read_text()
     |  'content of c'
     |
     |  existence:
     |
     |  >>> c.exists()
     |  True
     |  >>> (b / 'missing.txt').exists()
     |  False
     |
     |  Coercion to string:
     |
     |  >>> str(c)
     |  'abcde.zip/b/c.txt'
     |
     |  Methods defined here:
     |
     |  __init__(self, root, at='')
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  __repr__(self)
     |      Return repr(self).
     |
     |  __str__(self)
     |      Return str(self).
     |
     |  __truediv__ = joinpath(self, add)
     |
     |  exists(self)
     |
     |  is_dir(self)
     |
     |  is_file(self)
     |
     |  iterdir(self)
     |
     |  joinpath(self, add)
     |
     |  read_bytes(self)
     |
     |  read_text(self, *args, **kwargs)
     |
     |  ----------------------------------------------------------------------
     |  Readonly properties defined here:
     |
     |  name
     |
     |  open
     |
     |  parent
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  __dict__
     |      dictionary for instance variables (if defined)
     |
     |  __weakref__
     |      list of weak references to the object (if defined)

### class SanitizedNames
     |  ZipFile mix-in to ensure names are sanitized.
     |
     |  Methods defined here:
     |
     |  namelist(self)
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  __dict__
     |      dictionary for instance variables (if defined)
     |
     |  __weakref__
     |      list of weak references to the object (if defined)

## DATA
    division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 1310...

## FILE
    /usr/lib/python3/dist-packages/zipp.py