ZipFolder
=========

.. currentmodule:: Stoner.Zip

.. autoclass:: ZipFolder
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~ZipFolder.basenames
      ~ZipFolder.clone
      ~ZipFolder.debug
      ~ZipFolder.defaults
      ~ZipFolder.depth
      ~ZipFolder.directory
      ~ZipFolder.each
      ~ZipFolder.files
      ~ZipFolder.full_key
      ~ZipFolder.groups
      ~ZipFolder.instance
      ~ZipFolder.is_empty
      ~ZipFolder.key
      ~ZipFolder.layout
      ~ZipFolder.loaded
      ~ZipFolder.loader
      ~ZipFolder.ls
      ~ZipFolder.lsgrp
      ~ZipFolder.metadata
      ~ZipFolder.mindepth
      ~ZipFolder.not_empty
      ~ZipFolder.not_loaded
      ~ZipFolder.objects
      ~ZipFolder.pattern
      ~ZipFolder.root
      ~ZipFolder.setas
      ~ZipFolder.shape
      ~ZipFolder.trunkdepth
      ~ZipFolder.type

   .. rubric:: Methods Summary

   .. autosummary::

      ~ZipFolder.add_group
      ~ZipFolder.all
      ~ZipFolder.append
      ~ZipFolder.clear
      ~ZipFolder.compress
      ~ZipFolder.count
      ~ZipFolder.extend
      ~ZipFolder.fetch
      ~ZipFolder.file
      ~ZipFolder.filter
      ~ZipFolder.filterout
      ~ZipFolder.flatten
      ~ZipFolder.get
      ~ZipFolder.getlist
      ~ZipFolder.group
      ~ZipFolder.index
      ~ZipFolder.insert
      ~ZipFolder.items
      ~ZipFolder.keep_latest
      ~ZipFolder.keys
      ~ZipFolder.make_name
      ~ZipFolder.on_load_process
      ~ZipFolder.pop
      ~ZipFolder.popitem
      ~ZipFolder.prune
      ~ZipFolder.remove
      ~ZipFolder.reverse
      ~ZipFolder.save
      ~ZipFolder.select
      ~ZipFolder.setdefault
      ~ZipFolder.slice_metadata
      ~ZipFolder.sort
      ~ZipFolder.unflatten
      ~ZipFolder.unload
      ~ZipFolder.update
      ~ZipFolder.values
      ~ZipFolder.walk_groups
      ~ZipFolder.zip_groups

   .. rubric:: Attributes Documentation

   .. autoattribute:: basenames
   .. autoattribute:: clone
   .. autoattribute:: debug
   .. autoattribute:: defaults
   .. autoattribute:: depth
   .. autoattribute:: directory
   .. autoattribute:: each
   .. autoattribute:: files
   .. autoattribute:: full_key
   .. autoattribute:: groups
   .. autoattribute:: instance
   .. autoattribute:: is_empty
   .. autoattribute:: key
   .. autoattribute:: layout
   .. autoattribute:: loaded
   .. autoattribute:: loader
   .. autoattribute:: ls
   .. autoattribute:: lsgrp
   .. autoattribute:: metadata
   .. autoattribute:: mindepth
   .. autoattribute:: not_empty
   .. autoattribute:: not_loaded
   .. autoattribute:: objects
   .. autoattribute:: pattern
   .. autoattribute:: root
   .. autoattribute:: setas
   .. autoattribute:: shape
   .. autoattribute:: trunkdepth
   .. autoattribute:: type

   .. rubric:: Methods Documentation

   .. automethod:: add_group
   .. automethod:: all
   .. automethod:: append
   .. automethod:: clear
   .. automethod:: compress
   .. automethod:: count
   .. automethod:: extend
   .. automethod:: fetch
   .. automethod:: file
   .. automethod:: filter
   .. automethod:: filterout
   .. automethod:: flatten
   .. automethod:: get
   .. automethod:: getlist
   .. automethod:: group
   .. automethod:: index
   .. automethod:: insert
   .. automethod:: items
   .. automethod:: keep_latest
   .. automethod:: keys
   .. automethod:: make_name
   .. automethod:: on_load_process
   .. automethod:: pop
   .. automethod:: popitem
   .. automethod:: prune
   .. automethod:: remove
   .. automethod:: reverse
   .. automethod:: save
   .. automethod:: select
   .. automethod:: setdefault
   .. automethod:: slice_metadata
   .. automethod:: sort
   .. automethod:: unflatten
   .. automethod:: unload
   .. automethod:: update
   .. automethod:: values
   .. automethod:: walk_groups
   .. automethod:: zip_groups