.. title:: RTAConf

lisa.wlgen.rta.RTAConf
======================


.. autoclass:: lisa.wlgen.rta::RTAConf
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Attributes
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.wlgen.rta.RTAConf.ALLOWED_TASK_NAME_REGEX`
        -
         
         .. withrefctx::
            :module: lisa.wlgen.rta
            :class: lisa.wlgen.rta.RTAConf
         
         
            Regex to check whether the ``rt-app`` task name is valid.
      * - :attr:`~collections.abc.Mapping.__reversed__` :sup:`inherited`
        -
         See :attr:`collections.abc.Mapping.__reversed__`
   
   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.wlgen.rta.RTAConf.json`
        -
         
         .. withrefctx::
            :module: lisa.wlgen.rta
            :class: lisa.wlgen.rta.RTAConf
         
         
            rt-app configuration file content as a JSON string.
      * - :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.wlgen.rta.RTAConf.__getitem__`
        -
         
         .. withrefctx::
            :module: lisa.wlgen.rta
            :class: lisa.wlgen.rta.RTAConf
      * - :meth:`~lisa.wlgen.rta.RTAConf.__iter__`
        -
         
         .. withrefctx::
            :module: lisa.wlgen.rta
            :class: lisa.wlgen.rta.RTAConf
      * - :meth:`~lisa.wlgen.rta.RTAConf.__len__`
        -
         
         .. withrefctx::
            :module: lisa.wlgen.rta
            :class: lisa.wlgen.rta.RTAConf
      * - :meth:`~lisa.wlgen.rta.RTAConf._process_template`
        -
         
         .. withrefctx::
            :module: lisa.wlgen.rta
            :class: lisa.wlgen.rta.RTAConf
      * - :meth:`~lisa.wlgen.rta.RTAConf.from_path`
        -
         
         .. withrefctx::
            :module: lisa.wlgen.rta
            :class: lisa.wlgen.rta.RTAConf
         
         
            Same as :meth:`from_str` but with a file path instead.
      * - :meth:`~lisa.wlgen.rta.RTAConf.from_profile`
        -
         
         .. withrefctx::
            :module: lisa.wlgen.rta
            :class: lisa.wlgen.rta.RTAConf
         
         
            Create an rt-app workload using :class:`RTAPhase` instances.
      * - :meth:`~lisa.wlgen.rta.RTAConf.from_str`
        -
         
         .. withrefctx::
            :module: lisa.wlgen.rta
            :class: lisa.wlgen.rta.RTAConf
         
         
            Create an rt-app workload using a pure string description.
      * - :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:`~collections.abc.Mapping.get` :sup:`inherited`
        -
         See :meth:`collections.abc.Mapping.get`
      * - :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:`~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.utils.Loggable.log_locals` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Debugging aid: log the local variables of the calling function.
      * - :meth:`~collections.abc.Mapping.values` :sup:`inherited`
        -
         See :meth:`collections.abc.Mapping.values`
   


Attributes
----------


.. autoattribute:: lisa.wlgen.rta::RTAConf.ALLOWED_TASK_NAME_REGEX



.. autoattribute:: lisa.wlgen.rta::RTAConf.__reversed__



Properties
----------


.. autoproperty:: lisa.wlgen.rta::RTAConf.json



.. autoproperty:: lisa.wlgen.rta::RTAConf.logger



Methods
-------


.. automethod:: lisa.wlgen.rta::RTAConf.__getitem__



.. automethod:: lisa.wlgen.rta::RTAConf.__iter__



.. automethod:: lisa.wlgen.rta::RTAConf.__len__



.. automethod:: lisa.wlgen.rta::RTAConf._process_template



.. automethod:: lisa.wlgen.rta::RTAConf.from_path



.. automethod:: lisa.wlgen.rta::RTAConf.from_profile



.. automethod:: lisa.wlgen.rta::RTAConf.from_str



.. automethod:: lisa.wlgen.rta::RTAConf.__class_getitem__



.. automethod:: lisa.wlgen.rta::RTAConf.__contains__



.. automethod:: lisa.wlgen.rta::RTAConf.get



.. automethod:: lisa.wlgen.rta::RTAConf.get_logger



.. automethod:: lisa.wlgen.rta::RTAConf.items



.. automethod:: lisa.wlgen.rta::RTAConf.keys



.. automethod:: lisa.wlgen.rta::RTAConf.log_locals



.. automethod:: lisa.wlgen.rta::RTAConf.values