BaseFolder
==========

.. currentmodule:: Stoner.folders.core

.. autoclass:: BaseFolder
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

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

   .. rubric:: Methods Summary

   .. autosummary::

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

   .. rubric:: Attributes Documentation

   .. autoattribute:: clone
   .. autoattribute:: debug
   .. autoattribute:: defaults
   .. autoattribute:: depth
   .. 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:: objects
   .. 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:: group
   .. automethod:: index
   .. automethod:: insert
   .. automethod:: items
   .. automethod:: keys
   .. automethod:: make_name
   .. automethod:: pop
   .. automethod:: popitem
   .. automethod:: prune
   .. automethod:: remove
   .. automethod:: reverse
   .. automethod:: select
   .. automethod:: setdefault
   .. automethod:: slice_metadata
   .. automethod:: sort
   .. automethod:: unflatten
   .. automethod:: update
   .. automethod:: values
   .. automethod:: walk_groups
   .. automethod:: zip_groups