:py:mod:`anypytools.macro_commands`
===================================

.. py:module:: anypytools.macro_commands

.. autodoc2-docstring:: anypytools.macro_commands
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`MacroCommand <anypytools.macroutils.MacroCommand>`
     - .. autodoc2-docstring:: anypytools.macroutils.MacroCommand
          :summary:
   * - :py:obj:`Load <anypytools.macroutils.Load>`
     - .. autodoc2-docstring:: anypytools.macroutils.Load
          :summary:
   * - :py:obj:`SetValue <anypytools.macroutils.SetValue>`
     - .. autodoc2-docstring:: anypytools.macroutils.SetValue
          :summary:
   * - :py:obj:`SetValue_random <anypytools.macroutils.SetValue_random>`
     - .. autodoc2-docstring:: anypytools.macroutils.SetValue_random
          :summary:
   * - :py:obj:`Dump <anypytools.macroutils.Dump>`
     - .. autodoc2-docstring:: anypytools.macroutils.Dump
          :summary:
   * - :py:obj:`Export <anypytools.macroutils.Export>`
     - .. autodoc2-docstring:: anypytools.macroutils.Export
          :summary:
   * - :py:obj:`ExtendOutput <anypytools.macroutils.ExtendOutput>`
     - .. autodoc2-docstring:: anypytools.macroutils.ExtendOutput
          :summary:
   * - :py:obj:`SaveDesign <anypytools.macroutils.SaveDesign>`
     - .. autodoc2-docstring:: anypytools.macroutils.SaveDesign
          :summary:
   * - :py:obj:`LoadDesign <anypytools.macroutils.LoadDesign>`
     - .. autodoc2-docstring:: anypytools.macroutils.LoadDesign
          :summary:
   * - :py:obj:`SaveValues <anypytools.macroutils.SaveValues>`
     - .. autodoc2-docstring:: anypytools.macroutils.SaveValues
          :summary:
   * - :py:obj:`LoadValues <anypytools.macroutils.LoadValues>`
     - .. autodoc2-docstring:: anypytools.macroutils.LoadValues
          :summary:
   * - :py:obj:`UpdateValues <anypytools.macroutils.UpdateValues>`
     - .. autodoc2-docstring:: anypytools.macroutils.UpdateValues
          :summary:
   * - :py:obj:`OperationRun <anypytools.macroutils.OperationRun>`
     - .. autodoc2-docstring:: anypytools.macroutils.OperationRun
          :summary:
   * - :py:obj:`RunOperation <anypytools.macroutils.RunOperation>`
     - .. autodoc2-docstring:: anypytools.macroutils.RunOperation
          :summary:
   * - :py:obj:`SaveData <anypytools.macroutils.SaveData>`
     - .. autodoc2-docstring:: anypytools.macroutils.SaveData
          :summary:
   * - :py:obj:`LoadData <anypytools.macroutils.LoadData>`
     - .. autodoc2-docstring:: anypytools.macroutils.LoadData
          :summary:

API
~~~

.. py:class:: MacroCommand(command)
   :canonical: anypytools.macroutils.MacroCommand

   Bases: :py:obj:`object`

   .. autodoc2-docstring:: anypytools.macroutils.MacroCommand

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.MacroCommand.__init__

   .. py:method:: __repr__()
      :canonical: anypytools.macroutils.MacroCommand.__repr__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.MacroCommand.get_macro

      .. autodoc2-docstring:: anypytools.macroutils.MacroCommand.get_macro

.. py:class:: Load(filename, defs={}, paths={})
   :canonical: anypytools.macroutils.Load

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.Load

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.Load.__init__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.Load.get_macro

.. py:class:: SetValue(var, value)
   :canonical: anypytools.macroutils.SetValue

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.SetValue

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.SetValue.__init__

   .. py:method:: __repr__()
      :canonical: anypytools.macroutils.SetValue.__repr__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.SetValue.get_macro

   .. py:method:: _format_macro(val)
      :canonical: anypytools.macroutils.SetValue._format_macro

      .. autodoc2-docstring:: anypytools.macroutils.SetValue._format_macro

.. py:class:: SetValue_random(var, frozen_distribution, default_lower_tail_probability=0.5)
   :canonical: anypytools.macroutils.SetValue_random

   Bases: :py:obj:`anypytools.macroutils.SetValue`

   .. autodoc2-docstring:: anypytools.macroutils.SetValue_random

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.SetValue_random.__init__

   .. py:method:: __repr__()
      :canonical: anypytools.macroutils.SetValue_random.__repr__

   .. py:method:: get_macro(index, lower_tail_probability=None, **kwarg)
      :canonical: anypytools.macroutils.SetValue_random.get_macro

.. py:class:: Dump(var, include_in_macro=None)
   :canonical: anypytools.macroutils.Dump

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.Dump

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.Dump.__init__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.Dump.get_macro

.. py:class:: Export(var: str | list[str], name: str | list[str] | None = None)
   :canonical: anypytools.macroutils.Export

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.Export

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.Export.__init__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.Export.get_macro

.. py:class:: ExtendOutput(var_name: str, value)
   :canonical: anypytools.macroutils.ExtendOutput

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.ExtendOutput

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.ExtendOutput.__init__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.ExtendOutput.get_macro

.. py:class:: SaveDesign(operation, filename)
   :canonical: anypytools.macroutils.SaveDesign

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.SaveDesign

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.SaveDesign.__init__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.SaveDesign.get_macro

.. py:class:: LoadDesign(operation, filename)
   :canonical: anypytools.macroutils.LoadDesign

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.LoadDesign

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.LoadDesign.__init__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.LoadDesign.get_macro

.. py:class:: SaveValues(filename)
   :canonical: anypytools.macroutils.SaveValues

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.SaveValues

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.SaveValues.__init__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.SaveValues.get_macro

.. py:class:: LoadValues(filename)
   :canonical: anypytools.macroutils.LoadValues

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.LoadValues

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.LoadValues.__init__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.LoadValues.get_macro

.. py:class:: UpdateValues()
   :canonical: anypytools.macroutils.UpdateValues

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.UpdateValues

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.UpdateValues.__init__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.UpdateValues.get_macro

.. py:class:: OperationRun(operation)
   :canonical: anypytools.macroutils.OperationRun

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.OperationRun

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.OperationRun.__init__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.OperationRun.get_macro

.. py:class:: RunOperation(operation)
   :canonical: anypytools.macroutils.RunOperation

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.RunOperation

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.RunOperation.__init__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.RunOperation.get_macro

.. py:class:: SaveData(operation, filename)
   :canonical: anypytools.macroutils.SaveData

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.SaveData

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.SaveData.__init__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.SaveData.get_macro

.. py:class:: LoadData(operation, filename)
   :canonical: anypytools.macroutils.LoadData

   Bases: :py:obj:`anypytools.macroutils.MacroCommand`

   .. autodoc2-docstring:: anypytools.macroutils.LoadData

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.macroutils.LoadData.__init__

   .. py:method:: get_macro(index, **kwarg)
      :canonical: anypytools.macroutils.LoadData.get_macro