DataFolder
==========

.. currentmodule:: Stoner.Folders

.. autoclass:: DataFolder
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

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

   .. rubric:: Methods Summary

   .. autosummary::

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

   .. rubric:: Attributes Documentation

   .. autoattribute:: basenames
   .. autoattribute:: clone
   .. autoattribute:: debug
   .. autoattribute:: defaults
   .. autoattribute:: depth
   .. autoattribute:: directory
   .. autoattribute:: each
   .. autoattribute:: files
   .. 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:: concatenate
   .. automethod:: count
   .. automethod:: extend
   .. automethod:: extract
   .. automethod:: fetch
   .. automethod:: file
   .. automethod:: filter
   .. automethod:: filterout
   .. automethod:: flatten
   .. automethod:: gather
   .. 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
