ppms.interface
abgelegt und müssen importierbar sein.
ppms.interface
package stellt drei Basisklassen zur Verfügung: BaseConverter
, BaseEnricher
sowie BaseValidator
.
PARAMETERS
. Hier wird ein Dictionary erwartet, dessen Schlüssel-Wert-Paar die Parameter darstellt, mit denen dieser Schnittstellen-Baustein konfiguriert werden kann.
parameters
zugegriffen werden.
Beispiel
PARAMETERS
ein Schlüssel-Wert-Paar definiert, dessen Schlüssel der Text "value" ist und der keinen Standardwert besitzt.
check
-Methode wird über self.parameters
auf die konfigurierten Parameter zugegriffen. Dabei wird der Wert des Parameters value
abgerufen.
from ppms.interface import BaseValidator, InvalidRecordException class Equals(BaseValidator): PARAMETERS = {'value': ''} def check(self, value): check_value = self.parameters['value'] if value != check_value: raise InvalidRecordException('"%s" is not equal to "%s"' % (value, check_value))
ppms.interface
erstellen und eine neue Klasse definieren, die von BaseValidator
erbt.
check(self, parameter)
implementiert werden.
InvalidRecordException
werfen, wenn die Validierung fehlgeschlagen ist.
Beispiel: Validator, der prüft, ob ein bestimmter Vorgang existiert
from ppms.interface import BaseValidator, InvalidRecordException class TaskExists(BaseValidator): PARAMETERS = {'project': ''} def check(self, task_id): pr_id = self.parameters['project'] task_record = ppms.search_record(463, [pr_id, task_id], [1097, 1098], True) if task_record is None: raise InvalidRecordException('There is no task "%s" in project "%s"' % (task_id, pr_id))
ppms.interface
erstellen und eine neue Klasse definieren, die von BaseEnricher
erbt.
enrich(self, parameter)
implementiert werden.
Beispiel: Enricher, um einen Text durch einen anderen zu ersetzen
from ppms.interface import BaseEnricher class Replacer(BaseEnricher): """Gives access to the str.replace function""" PARAMETERS = {'old_value': '', 'new_value': ''} def enrich(self, arg): return arg.replace(self.parameters['old_value'], self.parameters['new_value'])
ppms.interface
erstellen und eine neue Klasse definieren, die von BaseConverter
erbt.
convert(self, parameter)
implementiert werden.
Beispiel: Konverter, um einen Text in Großbuchstaben umzuwandeln
from ppms.interface import BaseConverter class ToUppercase(BaseConverter): def convert(self, value): return value.upper()
BaseInterfaceModule
erben.
Export
Reihenfolge | Signatur | Verwendung | Rückgabewert |
---|---|---|---|
1 | before_send(self) |
Bereitet das Modul für das Senden von Daten vor | Keinen |
2 | send(self) |
Sendet die Datensätze als Dictionaries | Muss alle Records einzeln per yield zurückgeben. Der Rückgabewert von yield ist entweder True , wenn der Datensatz erfolgreich empfangen wurde, oder False , wenn ein Fehler aufgetreten ist |
3 | after_send(self, was_successful) |
Hier können geöffnete Ressourcen wieder geschlossen werden. NEU Der Parameter was_successful gibt an, ob der Übertrag erfolgreich war. |
Keinen |
Import
Reihenfolge | Signatur | Verwendung | Rückgabewert |
---|---|---|---|
1 | before_receive(self) |
Bereitet das Modul für das Empfangen von Daten vor | Keinen |
2 | receive(self, record) |
Wird für jeden Datensatz einmal aufgerufen und empfängt den Datensatz | Gibt entweder True zurück, wenn der Datensatz erfolgreich verarbeitet wurde, oder wirft eine CantProcessRecordException |
3 | after_receive(self, was_successful) |
Hier können geöffnete Ressourcen wieder geschlossen werden. NEU Der Parameter was_successful gibt an, ob der Übertrag erfolgreich war. |
Keinen |
Export
Reihenfolge | Signatur | Verwendung | Rückgabewert |
---|---|---|---|
1 | before_send(self) |
Bereitet das Modul für das Senden von Daten vor | Keinen |
2 | send(self) |
Sendet die Datensätze als Dictionaries | Muss alle Records einzeln per yield zurückgeben. Der Rückgabewert von yield ist entweder True , wenn der Datensatz erfolgreich empfangen wurde, oder False , wenn ein Fehler aufgetreten ist |
3 | after_send(self) |
Hier können geöffnete Ressourcen wieder geschlossen werden | Keinen |
Import
Reihenfolge | Signatur | Verwendung | Rückgabewert |
---|---|---|---|
1 | before_receive(self) |
Bereitet das Modul für das Empfangen von Daten vor | Keinen |
2 | receive(self, record) |
Wird für jeden Datensatz einmal aufgerufen und empfängt den Datensatz | Gibt entweder True zurück, wenn der Datensatz erfolgreich verarbeitet wurde, oder wirft eine CantProcessRecordException |
3 | after_receive(self) |
Hier können geöffnete Ressourcen wieder geschlossen werden | Keinen |
Hinweise
Dataitem ![]() |
DI-Python-ID ![]() ![]() |
SQL-ID ![]() |
Spaltentyp ![]() |
DB-Länge ![]() |
DF-Länge ![]() |
Sonstiges |
---|---|---|---|---|---|---|
Übertragen am | transferred_on | TRANSFERRED_ON | Alpha | 80 | 80 | |
Status | status | STATUS | Zahl ohne NK, bis 4 Stellen | 2 | 2 | |
Schnittstellen-Konfiguration | config_id | CONFIG_ID | UUID | 16 | 36 | FK zur DT 560 |
Siehe auch: Hier finden Sie einen Überblick über alle PLANTA link-Inhalte |