.. title:: KeyDescBase

lisa.conf.KeyDescBase
=====================


.. autoclass:: lisa.conf::KeyDescBase
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Attributes
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.conf.KeyDescBase.help`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDescBase
         
         
            Help description associated with the key.
      * - :attr:`~lisa.conf.KeyDescBase.name`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDescBase
         
         
            Name of that key.
      * - :attr:`~lisa.conf.KeyDescBase.parent`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDescBase
         
         
            Parent :class:`LevelKeyDesc`.
   
   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.conf.KeyDescBase.path`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDescBase
         
         
            Path in the config file from the root to that key.
      * - :attr:`~lisa.conf.KeyDescBase.qualname`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDescBase
         
         
            Qualified name of the configuration key used for error reporting.
   
   
   .. rubric:: Methods
   
   .. list-table::
      :align: left
   
      * - :meth:`~lisa.conf.KeyDescBase.get_help`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDescBase
         
         
            Get a help message describing the key.
      * - :meth:`~lisa.conf.KeyDescBase.validate_val`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDescBase
         
         
            Validate a value to be used for that key.
   


Attributes
----------


.. attribute:: KeyDescBase.help
   :canonical: lisa.conf.KeyDescBase.help

   
   .. withrefctx::
      :module: lisa.conf
      :class: lisa.conf.KeyDescBase
   
   
      Help description associated with the key.
      
   



.. attribute:: KeyDescBase.name
   :canonical: lisa.conf.KeyDescBase.name

   
   .. withrefctx::
      :module: lisa.conf
      :class: lisa.conf.KeyDescBase
   
   
      Name of that key.
      
   



.. attribute:: KeyDescBase.parent
   :canonical: lisa.conf.KeyDescBase.parent

   
   .. withrefctx::
      :module: lisa.conf
      :class: lisa.conf.KeyDescBase
   
   
      Parent :class:`LevelKeyDesc`.
      
   



Properties
----------


.. autoproperty:: lisa.conf::KeyDescBase.path



.. autoproperty:: lisa.conf::KeyDescBase.qualname



Methods
-------


.. automethod:: lisa.conf::KeyDescBase.get_help



.. automethod:: lisa.conf::KeyDescBase.validate_val