visuanalytics.util package

Submodules

visuanalytics.util.config_manager module

Dieses Modul stellt Methoden für den Zugriff auf private sowie öffentliche Konfigurationsparameter bereit.

get_config()

Ermöglicht den Zugriff auf die Konfigurationsdateien. Verwendet zuerst die Konfigurationsdatei in CONFIG_LOCATION. Ist auch eine Konfigurationsdatei in CONFIG_PRIVATE_LOCATION vorhanden, werden beide Konfigurationen verwendet, bei Doppelungen werden die Einstellungen aus CONFIG_PRIVATE_LOACTION verwendet. Der Key api_keys wird von CONFIG_PRIVATE_LOCATION entfernt.

Rückgabe

Die Konfigurationsdateien in Form eines Dictionaries.

Rückgabetyp

dict

get_private()

Ermöglicht den Zugriff auf die private Konfigurationsdatei.

Rückgabe

Die private Konfigurationsdatei in Form eines Dictionaries.

Rückgabetyp

dict

Raises

FileNotFoundError: Wenn die private Konfigurationsdatei nicht existiert.

Example

config = config_manager.get_private() print(config[„api_keys“][„weatherbit“])

=> Gibt den API-Key auf der Konsole aus.

visuanalytics.util.dict_utils module

merge_dict(dict1, dict2)

visuanalytics.util.external_programs module

all_installed(programs: list)

Testet, ob alle Programme von der Liste installiert sind.

Parameter

programs (list) – Liste der benötigten Programme.

visuanalytics.util.init module

init(config: dict)

visuanalytics.util.resources module

Modul, welches Funktionen zur Benutzung von Ressourcen bereitstellt.

AUDIO_LOCATION = 'audio'

Name des Audioordners. Wird beim Starten mit dem Wert aus der Konfigurationsdatei initialisiert.

DATE_FORMAT = '%Y-%m-%d_%H-%M.%S'

Datums- und Zeitformat in welchem die Dateien abgespeichert werden.

IMAGES_LOCATION = 'images'

Name des Bilderordners. Wird beim Starten mit dem Wert aus der Konfigurationsdatei initialisiert.

MEMORY_LOCATION = 'memory'

Name des Ordner für Memory-Dateien. Dient zum Abspeichern von vorherigen Berechnungen. Wird beim Starten mit dem Wert aus der Konfigurationsdatei initialisiert.

RESOURCES_LOCATION = 'resources'

Pfad zum Ordner „resources“ . Wird beim Starten mit dem Wert aus der Konfigurationsdatei initialisiert.

ROOT_LOCATION = '../'

Relativer Pfad zur root-Location.

TEMP_LOCATION = 'temp'

Name des Ordners für temporäre Dateien. Wird beim Starten mit dem Wert aus der Konfigurationsdatei initialisiert.

delete_resource(path: str)

Löscht die übergebene Ressource.

Verwendet get_resource_path(), um den Pfad der Ressource zu bekommen. Ist die Ressource nicht vorhanden, wird das ignoriert. Ist der angegebene Pfad allerdings ein Ordner, wird ein Fehler geworfen.

Parameter

path – Pfad zur Ressource, relativ zum resources-Ordner.

Raises

OSError

get_audio_path(path: str)

Erstellt einen absoluten Pfad zu der übergebenen Audio-Ressource.

Erstellt den Pfad aus RESOURCES_LOCATION und dem übergebenen Pfad.

Parameter

path – Pfad zur Ressource, relativ zum resources-Ordner.

Rückgabe

Absoluter Pfad zur übergebenen Ressource.

get_current_time()

Gibt die aktuelle Uhrzeit in Form eines Strings zurück. :return: Uhrzeit

get_image_path(path: str)

Erstellt einen absoluten Pfad zu der übergebenen Image-Ressource.

Erstellt den Pfad aus RESOURCES_LOCATION und dem übergebenen Pfad.

Parameter

path – Pfad zur Ressource, relativ zum resources-Ordner.

Rückgabe

Absoluter Pfad zur übergebenen Ressource.

get_memory_path(path: str, name: str, job_name: str)

Erstellt einen absoluten Pfad zu der übergebenen Ressource im Memory-Ordner.

Parameter

  • path – Pfad zur Ressource, relativ zum resources/memory-Ordner.

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

get_out_path(time, out_path, job_name, format='.mp4', thumbnail=False)

Gibt die aktuelle Uhrzeit in Form eines String zurück.

Parameter

  • out_path (str) – Pfad, an dem das Video abgelegt werden soll.

  • job_name (str) – Eine Beschreibung des Jobs, der gerade ausgeführt wird.

  • format (str) – Format in welchem gespeichert werden soll.

  • thumbnail – Ob es sich um einen Thumbnail handelt.

Rückgabe

Die aktuelle Uhrzeit für den Dateinamen (zum Erstellen des Videos).

Rückgabetyp

str

get_relative_temp_resource_path(path: str, pipeline_id: str)

Erstellt einen Relativen Pfad zu der übergebene Ressource im Temp Ordner.

Parameter

  • path – Pfad zur Ressource, relativ zum resources/temp Ordner.

  • pipeline_id (str) – id der Pipeline, von der die Funktion aufgerufen wurde.

get_resource_path(path: str)

Erstellt einen absoluten Pfad zu der übergebenen Ressource.

Erstellt den Pfad aus RESOURCES_LOCATION und dem übergebenen Pfad.

Parameter

path – Pfad zur Ressource, relativ zum resources-Ordner.

Rückgabe

Absoluter Pfad zur übergebenen Ressource.

get_specific_memory_path(job_name: str, name: str, number: int, skip: bool)

Erstellt einen absoluten Pfad zu der Memory-Datei im übergebenen Ordner.

Parameter

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

  • name – Name des Dictionaries, das exportiert wurde.

  • number – Angabe, welche Datei ausgewählt werden soll (0= zuletzt erstellt, 1 = als vorletztes erstellt etc.)

get_temp_resource_path(path: str, pipeline_id: str)

Erstellt einen absoluten Pfad zu der übergebene Ressource im Temp-Ordner.

Parameter

  • path – Pfad zur Ressource, relativ zum resources/temp-Ordner.

  • pipeline_id (str) – id der Pipeline von der die Funktion aufgerufen wurde.

new_memory_resource_path(job_name: str, name: str)

Erstellt einen absoluten Pfad für eine neue Memory-Resource.

Generiert einen neuen Namen mit aktuellem Zeitstempel. Verwendet um den Pfad zu generieren get_memory_path() mit dem Ordner des job_name.

Parameter

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

  • name – Name der Datei (ohne Datum)

new_temp_resource_path(pipeline_id: str, extension)

Erstellt einen absoluten Pfad für eine neue Resource.

Generiert einen neuen Namen mit aktuellem Zeitstempel. Verwendet um den Pfad zu generieren get_temp_resource_path() mit dem Ordner der pipeline_id.

Parameter

  • pipeline_id (str) – id der Pipeline von der die Funktion aufgerufen wurde.

  • extension (str) – Dateierweiterung ohne .

open_memory_resource(job_name: str, name: str, time_delta, mode: str = 'rt')

Öffnet die übergebene Memory-Ressource.

Parameter

  • time_delta – Tage, die abgezogen werden sollen vom heutigen Tag. Zum Öffnen der richtigen Ressource.

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

  • name – Name der Datei (ohne Datum).

  • mode – Mode zum Öffnen der Datei siehe open().

open_resource(path: str, mode: str = 'rt')

Öffnet die übergebene Ressource.

Verwendet get_resource_path(), um den Pfad der Ressource zu bekommen. Ist die Datei oder darüber liegende Ordner nicht vorhanden, werden diese erstellt.

Parameter

  • path – Pfad zur Resource, relativ zum resources-Ordner.

  • mode – Mode zum Öffnen der Datei siehe open().

Rückgabe

Die geöffnete Datei (siehe open()).

Raises

OSError

open_specific_memory_resource(job_name: str, name: str, skip, number: int = 1, mode: str = 'rt')

Öffnet die angegebene Memory-Ressource.

Parameter

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

  • name – Name des Dictionaries, das exportiert wurde.

  • number – Angabe, welche Datei ausgewählt werden soll (0= zuletz erstellt, 1 = als vorletztes erstellt etc.)

  • mode – Mode zum Öffnen der Datei siehe open().

open_temp_resource(path: str, pipeline_id: str, mode: str = 'rt')

Öffnet die übergebene Temp-Ressource.

Verwendet get_temp_resource_path()

Parameter

  • pipeline_id – id der Pipeline von der die Funktion aufgerufen wurde.

  • path – Pfad zur Resource, relativ zum resources-Ordner.

  • mode – Mode zum Öffnen der Datei siehe open().

path_from_root(path)

Erstellt einen Pfad relativ zum root-Ordner (visuanalytics).

Parameter

path – relativer Pfad

Rückgabe

absoluter Pfad zu root/path

Module contents