visuanalytics.analytics.util package

Submodules

visuanalytics.analytics.util.step_errors module

Fehlerklassen

exception APIError(values)

Bases: visuanalytics.analytics.util.step_errors.StepError

exception APIKeyError(api_key_name)

Bases: Exception

Fehlerklasse für einen nicht-gefundenen API-Key-Namen.

exception APiRequestError(response: requests.models.Response)

Bases: Exception

Fehlerklasse für einen fehlgeschlagenen http/s-Request.

exception AudioError(values)

Bases: visuanalytics.analytics.util.step_errors.StepError

exception FFmpegError(exitCode, output)

Bases: Exception

exception ImageError(values)

Bases: visuanalytics.analytics.util.step_errors.StepError

exception InvalidContentTypeError(url, content_type: str, expected_type="'application/json'")

Bases: Exception

exception PreconditionError(values)

Bases: visuanalytics.analytics.util.step_errors.StepError

exception PreconditionNotFulfilledError(count: int)

Bases: Exception

exception PresetError(key)

Bases: Exception

exception SequenceError(values)

Bases: visuanalytics.analytics.util.step_errors.StepError

exception StepError(values)

Bases: Exception

Fehlerklasse für einen Fehler, der in einem der Schritte auftritt.

Verwendet self.__cause__, um an Informationen eines vorherigen Fehlers zu kommen. Sollte deshalb nur mit einem raises StepError(values) from Exception verwendet werden.

exception StepKeyError(func_name, keys)

Bases: Exception

Fehlerklasse für einen fehlerhaften Data-Key.

exception StepTypeError(type)

Bases: Exception

Fehlerklasse für einen Typen-Fehler, der innerhalb eines Schrittes auftritt.

exception StoringError(values)

Bases: visuanalytics.analytics.util.step_errors.StepError

exception TestDataError(file_name: str)

Bases: OSError

FehlerKlasse für das Laden von Testdaten.

exception ThumbnailError(values)

Bases: visuanalytics.analytics.util.step_errors.StepError

exception TransformError(values)

Bases: visuanalytics.analytics.util.step_errors.StepError

raise_step_error(error: Type[visuanalytics.analytics.util.step_errors.StepError])

Gibt einen Decorator zurück, der die Original-Funktion mit einem try-except-Block umschließt. Die in error übergebene Exception wird dann anstatt der erwarteten Exception geworfen.

Parameter

error – Neue Fehlerklasse

Rückgabe

Decorator

visuanalytics.analytics.util.step_pattern module

class StepPatternFormatter(split_key='|')

Bases: string.Formatter

get_value(key, args, kwargs)
data_get_pattern(keys, data, split_key='|')
data_insert_pattern(keys, data, value, split_key='|')
data_remove_pattern(keys, data, split_key='|')

visuanalytics.analytics.util.step_utils module

Modul mit Typ-Methoden, die in images, transform und audio verwendet werden können.

execute_type_compare(values: dict, data: visuanalytics.analytics.control.procedures.step_data.StepData)
execute_type_option(values: dict, data: visuanalytics.analytics.control.procedures.step_data.StepData)

visuanalytics.analytics.util.type_utils module

get_type_func(values: dict, types: dict, key='type')

Hilfsfunktion, um die Typfunktion aus einem Dictonary zu bekommen.

Ist der Typ (Eintrag in types) nicht vorhanden, wird ein StepTypeError geworfen.

Parameter

  • values – Werte aus der JSON-Datei.

  • types – Dictionary mit type: func

  • key – Key des Typen in values

Rückgabe

gesuchte Funktion

Raises

StepTypeError

register_type_func(types: dict, error: Type[visuanalytics.analytics.util.step_errors.StepError], func)

Registriert die übergebene Funktion und versieht sie mit einem try-except-Block.

Parameter

  • types – Dictionary, in dem der Typ registriert werden soll.

  • error – Fehler, der geworfen werden soll.

  • func – Zu registrierende Funktion.

Rückgabe

Funktion mit try-catch-Block.

register_type_func_no_data(types: dict, error: Type[visuanalytics.analytics.util.step_errors.StepError], func)

visuanalytics.analytics.util.video_delete module

Modul, welches die erstellten Videos nach einem angegebenem Zeitraum wieder entfernt.

delete_amount_videos(job_name: str, output_path: str, count: int)

Methode zum Löschen von erstellten Videos. Diese Methode löscht alle Videos eines Jobs bis auf die vorgegebene Anzahl.

Beispiel: Es wurden 5 Videos erstellten. Die vorgegebene Anzahl ist drei, also werden die 2 ältesten Videos gelöscht.

Parameter

  • job_name – Name des Jobs (string)

  • output_path – Der Pfad zum Output-Ordner

  • count – Die Anzahl an Videos, die erhalten bleiben sollen.

delete_fix_name_videos(job_name: str, fix_names: list, output_path: str, values: dict, thumbnail: bool)

Methode zum Umbenennen der erstellten Videos nach dem Style in der Konfiguration.

Parameter

  • job_name – Name des Jobs (string).

  • fix_names – Liste, wie die Video zu heißen haben.

  • output_path – Der Pfad zum Output-Ordner.

  • values – Werte aus der JSON-Datei.

  • sym – Boolean, ob Thumbnails ebenso umbenannt werden sollen.

delete_memory_files(job_name: str, name: str, count: int)

Löscht Memory-Dateien sobald zu viele vorhanden sind.

Parameter

  • job_name – Name des Jobs von der die Funktion aufgerufen wurde.

  • name – Name des Dictionaries, das exportiert wurde.

  • count – Anzahl an Memory-Dateien, die vorhanden sein sollen (danach wird gelöscht).

delete_on_time(jobs: dict, output_path: str, name_key: str, check, get_time)

Methode zum Löschen von erstellten Videos nach einem vorgegebenen Zeitraum.

Parameter

  • jobs – Eine Liste aller Jobs

  • output_path – Der Pfad zum Output-Ordner

delete_video(steps_config, __config)

Methode, welche vom Scheduler aufgerufen wird und entscheidet, welche Methode von video_delete aufgerufen werden soll.

Parameter

  • steps_config – Konfiguration aus jobs.json

  • __config – Werte aus der JSON-Datei

Rückgabe

Module contents