.. title:: RunForTimeWload lisa.wlgen.rta.RunForTimeWload ============================== .. autoclass:: lisa.wlgen.rta::RunForTimeWload :no-members: :no-inherited-members: :no-undoc-members: :no-private-members: :no-special-members: .. rubric:: Classes .. list-table:: :align: left * - :class:`~lisa.wlgen.rta.PropertyBase.__class__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.PropertyBase.__class__ Metaclass for properties. .. rubric:: Attributes .. list-table:: :align: left * - :attr:`~lisa.wlgen.rta.RunForTimeWload.KEY` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.PropertyBase Subclasses can override this attribute so that :meth:`PropertyBase.from_key` knows that it can call their :meth:`~PropertyBase._from_key` method for that key. * - :attr:`~lisa.wlgen.rta.WloadPropertyBase.JSON_KEY` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.WloadPropertyBase * - :attr:`~lisa.wlgen.rta.ConcretePropertyBase.OPTIMIZE_JSON_KEYS` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.ConcretePropertyBase Configuration driving the JSON optimization, as a ``dict(str, set(str))``. * - :attr:`~lisa.wlgen.rta.ConcretePropertyBase.REQUIRED_KCONFIG_KEYS` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.ConcretePropertyBase List of KCONFIG keys that need to be =Y on the target kernel for this property to be usable. .. rubric:: Properties .. list-table:: :align: left * - :attr:`~lisa.wlgen.rta.DurationWload.json_value` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.DurationWload Value to pass to JSON. * - :attr:`~lisa.wlgen.rta.PropertyBase.key` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.PropertyBase Key of the instance. * - :attr:`~lisa.utils.Loggable.logger` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Convenience short-hand for ``self.get_logger()``. * - :attr:`~lisa.wlgen.rta.WloadPropertyBase.val` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.WloadPropertyBase Value "payload" of the property. .. rubric:: Methods .. list-table:: :align: left * - :meth:`~lisa.utils.SimpleHash.HASH_COERCE` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.SimpleHash Used to coerce the values of ``self.__dict__`` to hashable values. * - :meth:`~lisa.wlgen.rta.WloadPropertyBase.__add__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.WloadPropertyBase Adding two workloads together concatenates them. * - :meth:`~lisa.wlgen.rta.DurationWload.__and__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta._SingleWloadBase Combine two instances of the same property together. * - :meth:`~lisa.wlgen.rta.WloadPropertyBase.__await__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.WloadPropertyBase * - :meth:`~lisa.wlgen.rta.WloadPropertyBase.__mul__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.WloadPropertyBase Replicate the given workload ``n`` times. * - :meth:`~lisa.wlgen.rta.WloadPropertyBase.__rmul__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.WloadPropertyBase * - :meth:`~lisa.wlgen.rta.ConcretePropertyBase.check_kconfig` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.ConcretePropertyBase Check whether ``plat_info`` contains the kernel KCONFIG keys contained in :attr:`~ConcretePropertyBase.REQUIRED_KCONFIG_KEYS`. * - :meth:`~lisa.wlgen.rta.PropertyBase.find_cls` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.PropertyBase Find which subclass can handle ``key``. * - :meth:`~lisa.wlgen.rta.DurationWload.from_duration` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.DurationWload Build a workload from the given ``duration`` in seconds. * - :meth:`~lisa.wlgen.rta.PropertyBase.from_key` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.PropertyBase Alternative constructor that is available with the same signature for all properties. * - :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. * - :meth:`~lisa.wlgen.rta.ConcretePropertyBase.to_default_json` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.ConcretePropertyBase Similar to :meth:`~ConcretePropertyBase.to_json` but returns the default values for the keys set in :meth:`~ConcretePropertyBase.to_json`. * - :meth:`~lisa.wlgen.rta.DurationWload.to_events` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta._SingleWloadBase * - :meth:`~lisa.wlgen.rta.ConcretePropertyBase.to_json` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.ConcretePropertyBase Snippet of JSON content for that property as Python objects. Classes ------- .. autoclass:: lisa.wlgen.rta::RunForTimeWload.__class__ Attributes ---------- .. autoattribute:: lisa.wlgen.rta::RunForTimeWload.KEY .. autoattribute:: lisa.wlgen.rta::RunForTimeWload.JSON_KEY .. autoattribute:: lisa.wlgen.rta::RunForTimeWload.OPTIMIZE_JSON_KEYS .. autoattribute:: lisa.wlgen.rta::RunForTimeWload.REQUIRED_KCONFIG_KEYS Properties ---------- .. autoproperty:: lisa.wlgen.rta::RunForTimeWload.json_value .. autoproperty:: lisa.wlgen.rta::RunForTimeWload.key .. autoproperty:: lisa.wlgen.rta::RunForTimeWload.logger .. autoproperty:: lisa.wlgen.rta::RunForTimeWload.val Methods ------- .. automethod:: lisa.wlgen.rta::RunForTimeWload.HASH_COERCE .. automethod:: lisa.wlgen.rta::RunForTimeWload.__add__ .. automethod:: lisa.wlgen.rta::RunForTimeWload.__and__ .. automethod:: lisa.wlgen.rta::RunForTimeWload.__await__ .. automethod:: lisa.wlgen.rta::RunForTimeWload.__mul__ .. automethod:: lisa.wlgen.rta::RunForTimeWload.__rmul__ .. automethod:: lisa.wlgen.rta::RunForTimeWload.check_kconfig .. automethod:: lisa.wlgen.rta::RunForTimeWload.find_cls .. automethod:: lisa.wlgen.rta::RunForTimeWload.from_duration .. automethod:: lisa.wlgen.rta::RunForTimeWload.from_key .. automethod:: lisa.wlgen.rta::RunForTimeWload.get_logger .. automethod:: lisa.wlgen.rta::RunForTimeWload.log_locals .. automethod:: lisa.wlgen.rta::RunForTimeWload.to_default_json .. automethod:: lisa.wlgen.rta::RunForTimeWload.to_events .. automethod:: lisa.wlgen.rta::RunForTimeWload.to_json