.. title:: KeyDesc

lisa.conf.KeyDesc
=================


.. autoclass:: lisa.conf::KeyDesc
   :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` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDescBase
         
         
            Help description associated with the key.
      * - :attr:`~lisa.conf.KeyDescBase.name` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDescBase
         
         
            Name of that key.
      * - :attr:`~lisa.conf.KeyDescBase.parent` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDescBase
         
         
            Parent :class:`LevelKeyDesc`.
   
   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.conf.KeyDesc.newtype`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDesc
         
         
            Unique type associated with that key.
      * - :attr:`~lisa.conf.KeyDescBase.path` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDescBase
         
         
            Path in the config file from the root to that key.
      * - :attr:`~lisa.conf.KeyDescBase.qualname` :sup:`inherited`
        -
         
         .. 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.KeyDesc.get_help`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDesc
         
         
            Get a help message describing the key.
      * - :meth:`~lisa.conf.KeyDesc.pretty_format`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDesc
         
         
            Format the value for pretty printing.
      * - :meth:`~lisa.conf.KeyDesc.validate_val`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.KeyDesc
         
         
            Check that the value is an instance of one of the type specified in the ``self.classinfo``.
   


Attributes
----------


.. attribute:: KeyDesc.help
   :canonical: lisa.conf.KeyDesc.help

   
   *Inherited attribute, see* :attr:`lisa.conf.KeyDescBase.help`
   
   
   .. withrefctx::
      :module: lisa.conf
      :class: lisa.conf.KeyDescBase
   
   
      Help description associated with the key.
   
   



.. attribute:: KeyDesc.name
   :canonical: lisa.conf.KeyDesc.name

   
   *Inherited attribute, see* :attr:`lisa.conf.KeyDescBase.name`
   
   
   .. withrefctx::
      :module: lisa.conf
      :class: lisa.conf.KeyDescBase
   
   
      Name of that key.
   
   



.. attribute:: KeyDesc.parent
   :canonical: lisa.conf.KeyDesc.parent

   
   *Inherited attribute, see* :attr:`lisa.conf.KeyDescBase.parent`
   
   
   .. withrefctx::
      :module: lisa.conf
      :class: lisa.conf.KeyDescBase
   
   
      Parent :class:`LevelKeyDesc`.
   
   



Properties
----------


.. autoproperty:: lisa.conf::KeyDesc.newtype



.. autoproperty:: lisa.conf::KeyDesc.path



.. autoproperty:: lisa.conf::KeyDesc.qualname



Methods
-------


.. automethod:: lisa.conf::KeyDesc.get_help



.. automethod:: lisa.conf::KeyDesc.pretty_format



.. automethod:: lisa.conf::KeyDesc.validate_val