octopus oc corelibs sql helpers

PL/SQL -Helferklassen

Tools zum automatischen Verarbeitung und Formatieren von PL/SQL-Code

Einschränkungen

• Multi-Objekt-Dateien werden nicht unterstützt. Dies bedeutet: eine Datei - ein Objekt mit create Anweisung. Das Ergebnis der Verarbeitung von Multi-Objekt-Dateien ist unvorhersehbar, sodass alle Tools (außer Str_Decoder ) eine Ausnahme anstellen.
• Objektnamen dürfen nur mit ASCII -Zeichen angegeben werden.
• Die Verwendung für nicht unterstützte Objektdefinitionen wird ebenfalls eine Ausnahme hervorrufen. Unterstützte Objekttypen sind:
  • VERFAHREN
  • FUNKTION
  • PAKET
  • Packungskörper

Details

str_decoder

Die einzige Funktion Decodod_to_str versucht, die Zeilencodierung zu erkennen und auf UTF-8 neu zu codieren. Erhöht ValueError , wenn die Codierung unmöglich ist.

Zusammenfassung

decode_to_str(line, probables=None)

• line - bytes -Objekt mit einem zu dekodierenden Text
• probables - list der str mit primären Codierungen, die sie überprüfen sollten. Standard: ['cp866', 'cp1251', 'koi8-r']
• Rückgabewert - str (decodiert und wieder auf UTF-8 )

Befehlszeilennutzung

Entschlüsseln Sie die ganze Datei in eine andere Datei. Führen Sie dies aus, um eine Liste der Argumente zu erhalten:

python -m oc_sql_helpers.str_decoder --help

Verpackung

PLSQLWrapper -Klasse ist ein Werkzeug für die Arbeit mit Oracle-umgepackten Quellen.

Anforderungen

Es gibt zusätzliche Anforderungen, um Dateien zu wickeln . Beachten Sie, dass Ausweichmethoden ohne sie funktionieren. Diese sind auf die Verwendung des ursprünglichen wrap -Dienstprogramms von Oracle zurückzuführen , das aufgrund von Lizenzverletzungen nicht in diesem Paket enthalten ist . Sie müssen es separat installieren.

• ORACLE_HOME -Umgebungsvariable ist korrekt festzulegen
• wrap Binary soll unter ${ORACLE_HOME}/bin platziert werden und muss die Erlaubnis für einen effektiven Benutzer ausführen .

Zusammenfassung

PLSQLWrapper() - Ein Objekt für diese Klasse instanziieren

Methoden

• wrap_path(path_in, write_to=None)
  • path_in - str -Objekt mit absolutem oder relativem Pfad zu Datei zu Wickeln.
  • write_to - einer von:
    • None - Das Verpackungsergebnis wird nach dieser Methode als bytes -Objekt zurückgegeben
    • file - Ergebnis wird in das hier angegebene Datei -ähnliche Objekt geschrieben. Muss im Binärmodus von Read-Write ( 'w+b' ) geöffnet werden und unterstützen seek .
    • str - Pfad zum Ausgabedatei, absolut oder relativ. Das Ergebnis wird dort geschrieben. Muss eine Erweiterung haben - dies ist Oracle wrap Utility Featrue. Es findet .plb Suffix für sich selbst an, wenn eine Erweiterung weggelassen wird. Bitte geben Sie die Erweiterung immer an
  • Rückgabewert : Siehe write_to oben
• wrap_buf(fl_in, write_to=None)
  • fl_in - file oder file-like Objekt zum Wickeln von Daten aus. Muss im Binärmodus geöffnet werden und Support seek Operation ( 'rb' ).
  • write_to - das gleiche wie für wrap_path
  • Rückgabewert : Das gleiche wie für wrap_path
• unwrap_path(path_in, write_to=None)
  • path_in - str -Objekt mit absolutem oder relativem Pfad zur Datei zum Ausschalten.
  • write_to - einer von:
    • None - Das Entpackungsergebnis wird nach dieser Methode als bytes -Objekt zurückgegeben
    • file - Ergebnis wird in das hier angegebene Datei -ähnliche Objekt geschrieben. Muss im Binärmodus von Read-Write ( 'w+b' ) geöffnet werden und unterstützen seek .
    • str - Pfad zum Ausgabedatei, absolut oder relativ. Das Ergebnis wird dort geschrieben.
  • Rückgabewert : Siehe write_to oben
• unwrap_buf(fl_in, write_to=None)
  • fl_in - file oder file-like Objekt zum Wickeln von Daten aus. Muss im Binärmodus geöffnet werden und Support seek Operation ( 'rb' ).
  • write_to - das gleiche wie für unwrap_path
  • Rückgabewert : Das gleiche wie für unwrap_path

Befehlszeilennutzung

Wickeln/Auspacken Sie die ganze Datei in eine andere Datei. Führen Sie dies aus, um eine Liste der Argumente zu erhalten:

python -m oc_sql_helpers.wrapper --help

Normalisierer

PLSQLNormalizer -Klasse ist oder PL/SQL -Codenormalisierung .

Der Normalisierungsbegriff

Normalisierung bedeutet fast dasselbe wie der Codestil , aber weniger streng. Dies bedeutet, dass das Normalisierungsergebnis auch dann unbrauchbar sein kann, wenn die Quelle aus PL/SQL -Sicht korrekt ist.

Standardnormalisierung ist:

• Alle Linienendeen werden durch Unix -Style ersetzt
• Der gesamte Müll vor der ersten Erstellung CREATE wird entfernt.
• CREATE Anweisungen selbst wird in die erste Reihe von AS (oder IS oder WRAPPED ) Token, einschließlich Objektnamen, Typ und Schema, angeordnet. Zusätzliche Space -Zeichen und Kommentare werden durch einen einzelnen Raum ersetzt.
• Die erste Zeile (mit der ordnungsgemäßen CREATE erstellte) ist aufgeführt , einschließlich Schema und Objektname .
• Wenn ein Schema oder Objektname in Doppelquoten angegeben ist " "another.schema"."another.name" werden diese Doppelquoten nach Möglichkeit SCHEMA.NAME . Beispiel: "schema"."name" "ANOTHER.SCHEMA"."ANOTHER.NAME"
• Der Rest eines Teils des Objektdefinitionskörpers wird nicht verändert

Ein weiterer Normalisierungsflaggen :

• uppercase : Alle Sprachlexeme im Objektkörper werden außer Literalen oberen Zahlen sein
• no-comments : Alle Kommentare im Körper, einschließlich der Kommentarszeichen selbst, werden durch einen Raum ersetzt.
• no-spaces : Alle sich wiederholenden Raumschiffe (Raum selbst, Newline, Tabellierung ...) werden durch allgemeine Einzelraum ersetzt. Beispiel: var := 'the value' wird in var := 'the value' . Beachten Sie, dass in einem wörtlichen 'the value' kein Ersatz erfolgt. no-comments Flag
• no-literals : Alle Saiten-Literalwerte werden auf leere ersetzt. Die wörtlichen Zeichen selbst werden nicht geändert.
• comments-only : Verwerfen Sie den gesamten Dateiinhalt, aber Kommentare, einschließlich der Kommentare selbst. Jeder Kommentar wird mit einer neuen Zeile gestartet. Diese Flagge ist mit niemandem oben kompatibel

Zusammenfassung

PLSQLNormalizer() - ein Objekt für diese Klasse instanziieren

Methoden

• normalize_path(path, flags=None, lines=None, write_to=None)
  • path - str -Objekt mit absolutem oder relativem Pfad zur Normalisierung.
  • flags - Normalisierungsflags, list der Ganzzahlen aus der Aufzählung PLSQLNormalizationFlags , siehe unten. None Wert bedeutet nur eine Standardnormalisierung (Definition CREATE ).
  • lines - int , Grenznormalisierungslinien (aus der Quelle gezählt). Standard : None , bedeutet, die ganze Quelle zu normalisieren
  • write_to - einer von:
    • None - Das Verpackungsergebnis wird nach dieser Methode als bytes -Objekt zurückgegeben
    • file - Ergebnis wird in das hier angegebene Datei -ähnliche Objekt geschrieben. Muss im Binärmodus von Read-Write ( 'w+b' ) geöffnet werden und unterstützen seek .
    • str - Pfad zum Ausgabedatei, absolut oder relativ. Das Ergebnis wird dort geschrieben. Muss eine Erweiterung haben - dies ist Oracle wrap Utility Featrue. Es findet .plb Suffix für sich selbst an, wenn eine Erweiterung weggelassen wird. Bitte geben Sie die Erweiterung immer an
  • Rückgabewert : Siehe write_to oben
• normalize(fl, flags, lines=None write_to=None)
  • fl - einer von:
    • file oder file-like Objekt zum Normalisieren von Daten von. Muss im Binärmodus geöffnet werden und Support seek Operation ( 'rb' ).
    • str - String -Daten zur Normalisierung
    • bytes - "binäre" Daten zur Normalisierung
  • flags - genauso wie für normalize_path
  • lines - die gleiche wie für normalize_path
  • write_to - das gleiche wie für normalize_path
  • Rückgabewert : Das gleiche wie für normalize_path
• is_sql(fl) - Überprüfen Sie, ob die angegebenen Daten unterstützt werden
  • fl - Das gleiche wie bei normalize
  • RETUNTUR VALUE - bool , PL/SQL CODE oder nicht
• is_sql_path(path) - Das Gleiche wie is_sql , aber Argument wird als Pfad zu einer Datei mit einem möglichen Code behandelt
• is_wrapped(fl) - Überprüfen Sie, ob die angegebenen Daten unterstützt werden. PL/SQL -Code wird unterstützt
  • fl - Das gleiche wie bei normalize
  • RETUNTUR VALUE - bool , unterstützter PL/SQL -Code oder nicht
• is_wrapped_path(path) - Das gleiche wie is_wrapped , aber Argument wird als Pfad zu einer Datei mit einem möglichen Code behandelt
• is_wrappable(fl) - Überprüfen Sie, ob die angegebenen Daten unterstützt werden. PL/SQL -Code wird unterstützt
  • fl - Das gleiche wie bei normalize
  • RETUNTUR VALUE - bool , Wrappable PL/SQL -Objekt im Code oder nicht
• is_wrappable_path(path) - Das gleiche wie is_wrappable , aber das Argument wird als Pfad zu einer Datei mit einem möglichen Code behandelt

PLSQLNormalizationFlags - Aufzählung von Flags:

• uppercase
• no_comments
• no_spaces
• no_literals
• comments_only

Siehe detaillierte Beschreibung oben in einem anderen Normalisierungsflags Kapitel aus dem Abschnitt Normalisierungsbegriff .

Befehlszeilennutzung

Normalisierung der gesamten Datei in einer anderen Datei. Führen Sie dies aus, um eine Liste der Argumente zu erhalten:

python -m oc_sql_helpers.normalizer --help