diff --git a/script_helper.py b/script_helper.py index 9afd089332215ea4d6f0faa9809fbe566753eff6..d7425875fc1e610855e06499d913efd455c46efa 100644 --- a/script_helper.py +++ b/script_helper.py @@ -22,11 +22,17 @@ class DBTools: def select_adress(self) -> "list[tuple[str, ... ]]": """ - Funktion zum selektieren der Adressdaten der Schulen um diese zu - geocoden und ihnen URI aus dem AREG zuzuweisen. + Funktion zum selektieren der Adressdaten der Schulen aus der Datenbank. + Die folgenden Daten werden aus der Datenbank ausgelesen: + * ID der Schule in der Datenbank + * Hausnummer + * Straßenname + * PLZ + * Ortsname - :returns: Tupel mit alten Adressdaten der Schulen - :rtype: tuple + :returns: Liste mit mehreren Tupeln welche die Adressdaten der + Schulen enthalten. + :rtype: list """ select_sql = """ @@ -44,14 +50,14 @@ class DBTools: return query_result - def select_uri(self) -> "list[tuple[str,str]]": + def select_uri(self) -> "list[tuple[str, ... ]]": """ Funktion zum selektieren der URI aus dem Datensatz um diese mit - aktuellen AREG Adressen anzureichern. + aktuellen AREG Adressdaten anzureichern. - :return: Tupel mit den AREG URI die in der Datenbank vorhanden sind, - Safeguard ist vorhanden damit keine NULL Werte kommen. - :rtype: tuple + :return: Liste mit meheren Tupeln welche die AREG URI enthalten. + Es wird sichergestellt, dass keine NULL Werte vorkommen. + :rtype: list """ select_sql = """ @@ -69,7 +75,7 @@ class DBTools: def update_uri(self, param_dbid: str, param_uri: str) -> None: """ - Funktion zum Update der Datenbank mit den URI aus dem Geocoder. + Funktion zum Update der Datenbank mit den neuen URI aus dem Geocoder. :param str param_dbid: ID der Schule aus der Datenbank (nicht AREG URI) :param str param_uri: AREG URI @@ -97,11 +103,10 @@ class DBTools: def update_adress(self, data: "dict[str,str]", param_uri: str) -> None: """ Funktion zum Update der Datenbank mit den neuen Adressdaten aus dem - AREG anhand der URI. + AREG anhand der AREG URI. - :param dict data: GeoJSON aus der AREG API mit den aktuellen - Adressdaten - :param param_uri: AREG URI zum zuordnen der Adressdaten + :param dict data: Dictionary mit neuen Adressdaten aus der AREG API + :param str param_uri: AREG URI zum zuordnen der Adressdaten """ geometry = str(data['geometry']) geometry = geometry.replace("'", '"') @@ -155,23 +160,24 @@ class APITools: """ def __init__(self, param_url): """ - Festlegen der Base URL der API für die weitere Verwendung in den + Festlegen der Basis URL der API für die weitere Verwendung in den Funktionen der Klasse. - :param str param_url: Base URL der API + :param str param_url: Basis URL der API """ self.base_url = param_url def geocode(self, data: "dict[str,str]") -> "dict[str,str]": """ Funktion zum Aufrufen des Geocoder Prozesses in der API. Bereinigung - finden nicht in dieser Funktion oder diesem Skript sondern im Geocoder - statt! + der Adressdaten finden nicht in dieser Funktion oder diesem Skript + sondern im Geocoder statt! :param dict data: Dictionary mit den alten Adressdaten - :returns: Dictionary entweder mit einem "uri" Objekt oder einem - "message" Objekt, wenn uri kommt ist alles gut, wenn message kommt - dann ist ein fehler aufgetreten + :returns: Dictionary entweder mit einem `uri` Objekt oder einem + `message` Objekt. Wenn `uri` kommt ist alles gut, wenn `message` + kommt ist ein Fehler aufgetreten. Der genaue Fehler ist in + `message` enthalten. :rtype: dict """ url = self.base_url + r"processes/geocoder/execution" @@ -202,14 +208,11 @@ class APITools: def findadresse(self, param_uri: str) -> "dict[str,str]": """ - Funktion zum finden der Adresse im AREG anhand der vergebenen URI. - Antwort ist in Form eines Dictionaries. Die eigentrlichen Adress- - Attribute befinden sich im abschnitt `properties`. + Funktion zum finden der Adresse im AREG anhand der vergebenen AREG URI. + :param str param_uri: URL zur API mit AREG URI der Adresse. - :param str param_uri: URI des Datensatzes mit Link zur API. - - :return: GeoJSON des jeweiligen Items das der URI entspricht + :return: Adressdaten des jeweiligen Items das der AREG URI entspricht :rtype: dict """ url = param_uri + r"?f=json"