.. title:: ParametricPhase lisa.wlgen.rta.ParametricPhase ============================== .. autoclass:: lisa.wlgen.rta::ParametricPhase :no-members: :no-inherited-members: :no-undoc-members: :no-private-members: :no-special-members: .. rubric:: Classes .. list-table:: :align: left * - :class:`~lisa.wlgen.rta.ParametricPhase.DEFAULT_PHASE_CLS` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.ParametricPhase.DEFAULT_PHASE_CLS If no template is passed, an instance of this class will be used as template. .. rubric:: Attributes .. list-table:: :align: left * - :attr:`~collections.abc.Mapping.__reversed__` :sup:`inherited` - See :attr:`collections.abc.Mapping.__reversed__` .. rubric:: Properties .. list-table:: :align: left * - :attr:`~lisa.wlgen.rta.RTAPhaseTree.children` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseTree Tree levels are transparent and their children expanded directly in their parent, as long as they have no properties on their own that could change the output of :meth:`topo_sort()`. This allows nested :class:`RTAPhaseTree` to act as if it was just a flat node, which is useful since repeated composition with ``+`` operator will give nested binary trees like that. * - :attr:`~lisa.wlgen.rta.RTAPhaseTree.is_empty` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseTree ``True`` if the phase has no content and will result in an empty JSON phase(s). * - :attr:`~lisa.wlgen.rta.RTAPhaseTree.phases` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta._RTAPhaseTreeBase Topological sort of the phases in the tree, with the properties merged along each path from the root to the leaves. .. 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.RTAPhaseBase.__add__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseBase Compose two phases together by running one after the other. * - :meth:`~lisa.wlgen.rta.RTAPhaseBase.__await__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta._RTAPhaseBase * - :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.wlgen.rta.RTAPhaseBase.__getitem__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseBase Lookup the value of the given property on that phase. * - :meth:`~lisa.wlgen.rta.RTAPhaseBase.__init_subclass__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta._RTAPhaseBase Update the docstring used as a :meth:`str.format` template with the following keys:. * - :meth:`~lisa.wlgen.rta.RTAPhaseBase.__iter__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseBase * - :meth:`~lisa.wlgen.rta.RTAPhaseBase.__len__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseBase * - :meth:`~lisa.wlgen.rta.RTAPhaseBase.__mul__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseBase Multiply the phase by ``n``, in order to repeat it. * - :meth:`~lisa.wlgen.rta.RTAPhaseBase.__rmul__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseBase * - :meth:`~collections.abc.Mapping.get` :sup:`inherited` - See :meth:`collections.abc.Mapping.get` * - :meth:`~lisa.wlgen.rta.RTAPhaseTree.get_rtapp_repr` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta._RTAPhaseTreeBase rt-app JSON representation of the phase. * - :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.wlgen.rta.RTAPhaseBase.split_prop_kwargs` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseBase Split the ``kwargs`` into two categories:. * - :meth:`~lisa.wlgen.rta.RTAPhaseTree.topo_sort` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseTree Topological sort of the tree, and combine the properties along each path from root to leaves at the same time. * - :meth:`~collections.abc.Mapping.values` :sup:`inherited` - See :meth:`collections.abc.Mapping.values` * - :meth:`~lisa.wlgen.rta.RTAPhaseBase.with_delete_props` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseBase Delete all the given property names, equivalent to ``with_props(foo=delete())``. * - :meth:`~lisa.wlgen.rta.RTAPhaseBase.with_phase_properties` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseBase Return a cloned instance with the properties combined with the given ``properties`` using :meth:`RTAPhaseProperties.__and__` (``&``). The ``properties`` parameter is the left operand. If ``properties`` is ``None``, just return the phase itself. * - :meth:`~lisa.wlgen.rta.RTAPhaseBase.with_properties_map` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseBase Same as :meth:`with_phase_properties` but with ``properties`` passed to :meth:`RTAPhaseProperties.from_polymorphic` first. * - :meth:`~lisa.wlgen.rta.RTAPhaseBase.with_props` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTAPhaseBase Same as :meth:`with_phase_properties` but using keyword arguments to set each property. The resulting dictionary is passed to :meth:`RTAPhaseProperties.from_polymorphic` first. Classes ------- .. autoclass:: lisa.wlgen.rta::ParametricPhase.DEFAULT_PHASE_CLS Attributes ---------- .. autoattribute:: lisa.wlgen.rta::ParametricPhase.__reversed__ Properties ---------- .. autoproperty:: lisa.wlgen.rta::ParametricPhase.children .. autoproperty:: lisa.wlgen.rta::ParametricPhase.is_empty .. autoproperty:: lisa.wlgen.rta::ParametricPhase.phases Methods ------- .. automethod:: lisa.wlgen.rta::ParametricPhase.HASH_COERCE .. automethod:: lisa.wlgen.rta::ParametricPhase.__add__ .. automethod:: lisa.wlgen.rta::ParametricPhase.__await__ .. automethod:: lisa.wlgen.rta::ParametricPhase.__class_getitem__ .. automethod:: lisa.wlgen.rta::ParametricPhase.__contains__ .. automethod:: lisa.wlgen.rta::ParametricPhase.__getitem__ .. automethod:: lisa.wlgen.rta::ParametricPhase.__init_subclass__ .. automethod:: lisa.wlgen.rta::ParametricPhase.__iter__ .. automethod:: lisa.wlgen.rta::ParametricPhase.__len__ .. automethod:: lisa.wlgen.rta::ParametricPhase.__mul__ .. automethod:: lisa.wlgen.rta::ParametricPhase.__rmul__ .. automethod:: lisa.wlgen.rta::ParametricPhase.get .. automethod:: lisa.wlgen.rta::ParametricPhase.get_rtapp_repr .. automethod:: lisa.wlgen.rta::ParametricPhase.items .. automethod:: lisa.wlgen.rta::ParametricPhase.keys .. automethod:: lisa.wlgen.rta::ParametricPhase.split_prop_kwargs .. automethod:: lisa.wlgen.rta::ParametricPhase.topo_sort .. automethod:: lisa.wlgen.rta::ParametricPhase.values .. automethod:: lisa.wlgen.rta::ParametricPhase.with_delete_props .. automethod:: lisa.wlgen.rta::ParametricPhase.with_phase_properties .. automethod:: lisa.wlgen.rta::ParametricPhase.with_properties_map .. automethod:: lisa.wlgen.rta::ParametricPhase.with_props