Python Stub Files für builtin Modules

Viele Code Editoren wie zum Beispiel Visual Studio Code verfügen über statische Analyse-Fähigkeiten, um Fehler bereits vor der Ausführung zu erkennen.

Um die Vertec Python Module für die Type Checker verfügbar zu machen, liefern wir Stub Files der eingebauten Vertec Module vtcapp , vtcextensions, ziputils, vtcplanning, vtcplanningcore, reporting, vtccom, vtcindexing, vtcbi und vtcauth mit.

Bei On-Premises Kunden werden diese im Unterordner PythonStubs im Vertec Installationsverzeichnis abgelegt.

Cloud Abo Kunden können die Stub Files hier herunterladen und lokal speichern:

PythonStubs.zip

Anschliessend können Sie im Code Editor importiert werden.

Wie das geschieht, wird hier anhand des Beispiels Visual Studio Code erklärt.

1. Installieren Sie in Visual Studio Code die aktuelle Version von Pylance. Dafür klicken Sie links auf Manage (Zahnradsymbol) und wählen Extensions. Wählen Sie Pylance und klicken Sie auf Install.
   Möglicherweise erscheint eine Frage zur Default Language. Beantworten Sie diese mit Yes and reload.
2. Es wird Python 2.7 Unterstützung benötigt. Dafür installieren Sie zusätzlich die Python Extension.
3. Um den Vertec Stub Ordner in den Einstellungen zu hinterlegen, klicken Sie links wieder auf Manage und wählen Sie Settings.
4. Tippen Sie Python ein und wählen Sie Extensions > Pylance. Tragen Sie den Pfad zu Ihren Vertec Stub Files ein, z.B.:

5. 

6. Wählen Sie dann links an derselben Stelle das Unterverzeichnis Python und kontrollieren Sie, dass als Language Server Pylance eingetragen ist:

   

7. Starten Sie Visual Studio Code neu.

Das benötigte Module muss in den Scripts jeweils importiert werden, z.B. vtcapp:

import vtcapp

Besonderheiten des reporting.py Stub Files

Ab Vertec 6.6 liefern wir mit reporting.py auch ein Python Stub File für den Python-Code für Office-Berichte mit.

Dieses muss für die Verwendung wie gewohnt importiert werden: from reporting import *

Die Methoden, die im Office-Bericht Code selbst deklariert werden müssen (z.B. def initialize_row(context, row)), sind im Stub File zwar eingefügt, jedoch nur als Dokumentationshilfe (da die Methode ja nicht einfach verwendet wird, sondern selbst deklariert werden muss).

Damit die context-Variable funktioniert, muss in Python folgende Type-Annotation verwendet werden (Beispiel):

def calc_table(context):
    # type: (Context) -> Table