.. title:: TopLevelKeyDesc

lisa.conf.TopLevelKeyDesc
=========================


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

   
   .. rubric:: Attributes
   
   .. list-table::
      :align: left
   
      * - :attr:`~collections.abc.Mapping.__reversed__` :sup:`inherited`
        -
         See :attr:`collections.abc.Mapping.__reversed__`
      * - :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.LevelKeyDesc.key_desc` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.LevelKeyDesc
         
         
            Leaf :class:`KeyDescBase` that this level will delegate to in case it is assigned a leaf value.
      * - :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
   
      * - :func:`~collections.abc.Iterable.__class_getitem__` :sup:`inherited`
        -
         See :func:`collections.abc.Iterable.__class_getitem__`
      * - :meth:`~collections.abc.Mapping.__contains__` :sup:`inherited`
        -
         See :meth:`collections.abc.Mapping.__contains__`
      * - :meth:`~lisa.conf.LevelKeyDesc.__getattr__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.LevelKeyDesc
      * - :meth:`~lisa.conf.LevelKeyDesc.__getitem__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.LevelKeyDesc
      * - :meth:`~lisa.conf.LevelKeyDesc.__iter__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.LevelKeyDesc
      * - :meth:`~lisa.conf.LevelKeyDesc.__len__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.LevelKeyDesc
      * - :meth:`~lisa.conf.LevelKeyDesc.check_allowed_key` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.LevelKeyDesc
         
         
            Checks that a given key is allowed under that levels.
      * - :meth:`~collections.abc.Mapping.get` :sup:`inherited`
        -
         See :meth:`collections.abc.Mapping.get`
      * - :meth:`~lisa.conf.TopLevelKeyDescBase.get_help` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.TopLevelKeyDescBase
         
         
            Get a help message describing the key.
      * - :meth:`~collections.abc.Mapping.items` :sup:`inherited`
        -
         See :meth:`collections.abc.Mapping.items`
      * - :meth:`~collections.abc.Mapping.keys` :sup:`inherited`
        -
         See :meth:`collections.abc.Mapping.keys`
      * - :meth:`~lisa.conf.LevelKeyDesc.validate_val` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.LevelKeyDesc
         
         
            Validate a mapping to be used as a configuration source.
      * - :meth:`~collections.abc.Mapping.values` :sup:`inherited`
        -
         See :meth:`collections.abc.Mapping.values`
   


Attributes
----------


.. autoattribute:: lisa.conf::TopLevelKeyDesc.__reversed__



.. attribute:: TopLevelKeyDesc.help
   :canonical: lisa.conf.TopLevelKeyDesc.help

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



.. attribute:: TopLevelKeyDesc.name
   :canonical: lisa.conf.TopLevelKeyDesc.name

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



.. attribute:: TopLevelKeyDesc.parent
   :canonical: lisa.conf.TopLevelKeyDesc.parent

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



Properties
----------


.. autoproperty:: lisa.conf::TopLevelKeyDesc.key_desc



.. autoproperty:: lisa.conf::TopLevelKeyDesc.path



.. autoproperty:: lisa.conf::TopLevelKeyDesc.qualname



Methods
-------


.. automethod:: lisa.conf::TopLevelKeyDesc.__class_getitem__



.. automethod:: lisa.conf::TopLevelKeyDesc.__contains__



.. automethod:: lisa.conf::TopLevelKeyDesc.__getattr__



.. automethod:: lisa.conf::TopLevelKeyDesc.__getitem__



.. automethod:: lisa.conf::TopLevelKeyDesc.__iter__



.. automethod:: lisa.conf::TopLevelKeyDesc.__len__



.. automethod:: lisa.conf::TopLevelKeyDesc.check_allowed_key



.. automethod:: lisa.conf::TopLevelKeyDesc.get



.. automethod:: lisa.conf::TopLevelKeyDesc.get_help



.. automethod:: lisa.conf::TopLevelKeyDesc.items



.. automethod:: lisa.conf::TopLevelKeyDesc.keys



.. automethod:: lisa.conf::TopLevelKeyDesc.validate_val



.. automethod:: lisa.conf::TopLevelKeyDesc.values