.. title:: DirCache

lisa.utils.DirCache
===================


.. autoclass:: lisa.utils::DirCache
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.utils.Loggable.logger` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Convenience short-hand for ``self.get_logger()``.
   
   
   .. rubric:: Methods
   
   .. list-table::
      :align: left
   
      * - :meth:`~lisa.utils.DirCache.get_entry`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.DirCache
         
         
            Return the folder of a cache entry.
      * - :meth:`~lisa.utils.DirCache.get_key_token`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.DirCache
         
         
            Return the token associated with the given ``key``.
      * - :meth:`~lisa.utils.DirCache.has_key`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.DirCache
         
         
            Check if the given ``key`` is already present in the cache. If the key is present, return the path, otherwise returns ``None``.
      * - :meth:`~lisa.utils.Loggable.get_logger` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Provides a :class:`logging.Logger` named after ``cls``.
      * - :meth:`~lisa.utils.Loggable.log_locals` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Debugging aid: log the local variables of the calling function.
   


Properties
----------


.. autoproperty:: lisa.utils::DirCache.logger



Methods
-------


.. automethod:: lisa.utils::DirCache.get_entry



.. automethod:: lisa.utils::DirCache.get_key_token



.. automethod:: lisa.utils::DirCache.has_key



.. automethod:: lisa.utils::DirCache.get_logger



.. automethod:: lisa.utils::DirCache.log_locals