visuanalytics.analytics.apis package

Submodules

visuanalytics.analytics.apis.api module

Modul, welches die Funktionen bereitstellt, welche für API-Requests benötigt werden.

API_TYPES = {'input': <function input>, 'request': <function request>, 'request_memory': <function request_memory>, 'request_multiple': <function request_multiple>, 'request_multiple_custom': <function request_multiple_custom>}

Ein Dictionary bestehend aus allen API-Typ-Methoden.

api(values: dict, data: visuanalytics.analytics.control.procedures.step_data.StepData)
api_request(values: dict, data: visuanalytics.analytics.control.procedures.step_data.StepData, name: str, save_key, ignore_testing=False)
fetch(values: dict, data: visuanalytics.analytics.control.procedures.step_data.StepData, save_key)

Abfrage einer API und Umwandlung der API-Antwort in ein angegebenes Format.

Parameter

req_data – Dictionary, das alle Informationen für den request enthält.

Rückgabe

Antwort der API im angegebenen Format

input(values: dict, data: visuanalytics.analytics.control.procedures.step_data.StepData, name: str, save_key, ignore_testing=False)

Hier können Daten angegeben werden, die einfach hinzugefügt werden.

Parameter

  • values – Werte aus der JSON-Datei

  • data – Daten aus der API

  • name – Testdatei, die geladen werden soll.

  • save_key – Key, unter dem die Daten gespeichert werden.

  • ignore_testing – Ob der Request durchgeführt werden soll, obwohl testing true ist.

register_api(func)

Registriert die übergebene Funktion und versieht sie mit einem „try/except“-Block. Fügt eine Typ-Funktion dem Dictionary API_TYPES hinzu.

Parameter

func – die zu registrierende Funktion

Rückgabe

Funktion mit try/except-Block

request(values: dict, data: visuanalytics.analytics.control.procedures.step_data.StepData, name: str, save_key, ignore_testing=False)

Fragt einmal die gewünschten Daten einer API ab.

Parameter

  • values – Werte aus der JSON-Datei

  • data – Daten aus der API

  • name – Testdatei, die geladen werden soll.

  • save_key – Key, unter dem die Daten gespeichert werden.

  • ignore_testing – Ob der Request durchgeführt werden soll, obwohl testing true ist.

request_memory(values: dict, data: visuanalytics.analytics.control.procedures.step_data.StepData, name: str, save_key, ignore_testing=False)

Ließt Daten aus einer memory-Datei (JSON-Format) zu einem bestimmtem Datum.

Parameter

  • values – Werte aus der JSON-Datei

  • data – Daten aus der API

  • name – Testdatei, die geladen werden soll.

  • save_key – Key, unter dem die Daten gespeichert werden.

  • ignore_testing – Ob der Request durchgeführt werden soll, obwohl testing true ist.

request_multiple(values: dict, data: visuanalytics.analytics.control.procedures.step_data.StepData, name: str, save_key, ignore_testing=False)

Fragt für einen variablen Key, mehrere Male gewünschte Daten einer API ab.

Parameter

  • values – Werte aus der JSON-Datei

  • data – Daten aus der API

  • name – Testdatei, die geladen werden soll.

  • save_key – Key, unter dem die Daten gespeichert werden.

  • ignore_testing – Ob der Request durchgeführt werden soll, obwohl testing true ist.

request_multiple_custom(values: dict, data: visuanalytics.analytics.control.procedures.step_data.StepData, name: str, save_key, ignore_testing=False)

Fragt unterschiedliche Daten einer API ab.

Parameter

  • values – Werte aus der JSON-Datei

  • data – Daten aus der API

  • name – Testdatei, die geladen werden soll.

  • save_key – Key, unter dem die Daten gespeichert werden.

  • ignore_testing – Ob der Request durchgeführt werden soll, obwohl testing true ist.

Module contents