Switchboards programmatisch generieren
--------------------------------------

Diese Anleitung erklärt, wie Switchboard programmatisch mit Python generiert werden können.

Per PlexMap Shell
=================

.. todo:: Einführung in den Befehlt ``plexmapshell``

Per Python-Skript
=================

Zu allererst werden ein paar Python-Klassen importiert:

.. code-block:: python

    from plexgis.models import Switchboard, SwitchboardFolder
    from plexgis.components.switchboard.environments import SwitchboardExecutor

Wenn mehrere, gleichartige Switchboards angelegt werden sollen, empfiehlt es sich, einen Ordner
anzulegen. Dies ermöglicht die einfache Wiederfindung der Switchboards im Backend.

.. code-block:: python

    folder, _ = SwitchboardFolder.objects.get_or_create(name='Gruppenname')

Als nächstes kann nun das Switchboard selbst angelegt werden. Der folgende Beispielcode legt ein
Switchboard an, welches Zahlen von einem existierenden Depot nimmt, 1000 addiert und das Ergebnis in
ein anderes Depot schreibt:

.. code-block:: python

    sb, _ = Switchboard.objects.get_or_create(name='Switchboard name', folder=folder)

    with SwitchboardExecutor(switchboard=sb, run=False) as E:
        numbers = E.apply('depot.retrieve', ['Path/To/Source'])
        E.apply('depot.store', E.apply('math.add', numbers, [1000]), ['Path/To/Dest'])

.. todo:: apply-Parameter output_type erklären

.. todo:: apply-Parameter output_context erklären (lazy, ...)