Schnellstart: Erstellen eines Python-Projekts aus einer Vorlage in Visual Studio

In diesem Schnellstart folgen Sie einer Anleitung zur schnellen Erstellung einer Flask-Anwendung mit Hilfe einer integrierten Python-Projektvorlage. Visual Studio erleichtert die Entwicklung von Python-Projekten mit Boilerplate-Code und Funktionen in Vorlagen für verschiedene Python-Frameworks wie Flask, Django und Bottle. Das in diesem Artikel beschriebene Python-Projekt ähnelt dem Projekt, das Sie manuell über den Artikel Schnellstart: Erstellen einer Webanwendung mit Flask.

Voraussetzungen

• Visual Studio wurde mit Unterstützung für Python-Workloads installiert.

  Wählen Sie im Visual Studio Installer den Python-Entwicklungs-Workload und die Option Python-Webunterstützung für den Zugriff auf Webprojektvorlagen. Weitere Informationen finden Sie unter Installieren von Python-Unterstützung in Visual Studio.

  

Visual Studio für Mac wird nicht unterstützt. Weitere Informationen finden Sie unter Was passiert mit Visual Studio für Mac? Visual Studio Code unter Windows, Mac und Linux funktioniert gut mit Python über verfügbare Erweiterungen.

Erstellen des Projekts

Folgen Sie diesem Verfahren, um eine Visual Studio-Lösung und ein neues Flask-Webprojekt zu erstellen:

1. Wählen Sie in Visual Studio Datei>Neu>Projekt und suchen Sie nach „Flask“. Wählen Sie die Vorlage Leeres Flask-Webprojekt und wählen Sie Weiter.

   

2. Visual Studio zeigt das Dialogfeld für die Projektkonfiguration an. Geben Sie einen Namen für das Projekt ein und wählen Sie Erstellen. Die anderen Felder können Sie auf den Standardwerten belassen.

   

3. Nach einem kurzen Moment zeigt Visual Studio eine Prompt an, wie mit Paketabhängigkeiten umgegangen werden soll. Die Prompt ist unterschiedlich, je nachdem, ob Sie bereits Paketabhängigkeiten installiert haben.

   Das Dialogfeld Dieses Projekt benötigt externe Pakete. zeigt an, dass die ausgewählte Vorlage eine requirements.txt-Datei enthält, in der die Abhängigkeiten von dem Flask-Paket angegeben sind. Visual Studio kann die Pakete automatisch installieren, was Ihnen die Möglichkeit gibt, die Pakete in einer virtuellen Umgebung zu installieren. Das Verwenden einer virtuellen Umgebung ist der Installation in einer globalen Umgebung vorzuziehen.

   Wenn Sie dieses Dialogfeld erhalten, wählen Sie die Option In einer virtuellen Umgebung installieren:

   

   Alternativ dazu können Sie die Python-Paket-Spezifikationsdatei „requirements.txt“ im Projekt <Projektname>“. im Prompt oben im Visual Studio-Fenster sehen. Diese Aufforderung zeigt an, dass die Paketabhängigkeiten bereits in Ihrer Konfiguration vorhanden sind. Visual Studio kann aus der vorhandenen Konfiguration eine virtuelle Umgebung für Sie erstellen.

   Wenn Sie dieses Prompt sehen, wählen Sie die Option Virtuelle Umgebung erstellen:

   

4. Visual Studio zeigt das Dialogfeld Umgebung hinzufügen an. Übernehmen Sie die Standardwerte und klicken Sie auf Erstellen. Stimmen Sie etwaigen Anforderungen von Rechteerweiterungen zu.

   

Tipp

Wenn Sie mit einem neuen Projekt beginnen, wird dringend empfohlen, zu Beginn eine virtuelle Umgebung zu erstellen. Dazu werden Sie auch von den meisten Visual Studio-Vorlagen aufgefordert. Virtuelle Umgebungen behalten die genauen Anforderungen Ihres Projekts im Laufe der Zeit bei, wenn Bibliotheken hinzugefügt und entfernt werden. Dann können Sie mühelos eine requirements.txt-Datei erstellen, die Sie zur erneuten Installation dieser Abhängigkeiten auf anderen Entwicklungscomputern verwenden können (wie bei der Quellcodeverwaltung). Außerdem können Sie diese Datei verwenden, wenn Sie das Projekt auf einem Produktionsserver bereitstellen. Weitere Informationen zu virtuellen Umgebungen und deren Vorzügen finden Sie in den Artikeln Verwenden von virtuellen Umgebungen und Verwalten von erforderlichen Paketen mit „requirements.txt“.

Überprüfen der Codebausteine

In diesem Abschnitt untersuchen Sie den Boilerplate-Code in der Flask-Projektdatei (.py), die Visual Studio für die ausgewählte Vorlage erstellt.

1. Öffnen Sie Projektmappen-Explorer, um Ihre Projektmappe und die Flask-Projektdateien anzuzeigen. Das ursprüngliche Projekt enthält nur zwei Dateien, app.py und requirements.txt:

   

   In der Datei requirements.txt werden die Flask-Paketabhängigkeiten angegeben. Wegen dieser Datei werden Sie bei der erstmaligen Erstellung des Projekts zum Erstellen einer virtuellen Umgebung aufgefordert.

   Die einzelne app.py Datei enthält Codebausteine für ein leeres Flask-Webprojekt. Die Vorlage enthält Code, der den Beschreibungen im Artikel Schnellstart – Erstellen einer Web-App mit Flask ähnelt, mit einigen zusätzlichen Abschnitten.

2. Öffnen Sie die app.py-Datei im Editor und überprüfen Sie den oberen Abschnitt.

   Der Code beginnt mit einer import-Anweisung für das Flask-Paket. Diese Anweisung erzeugt eine Instanz der Klasse Flask, die der Variablen app zugewiesen wird:

   from flask import Flask
   app = Flask(__name__)
   

   Als Nächstes weist der Code die Variable wsgi_app zu, die nützlich ist, wenn Sie die Flask-Anwendung auf einem Webhost bereitstellen:

   # Make the WSGI interface available at the top level so wfastcgi can get it.
   wsgi_app = app.wsgi_app
   

3. Der mittlere Abschnitt weist einer URL-Route eine Funktion zu, was bedeutet, dass die Funktion die durch die URL identifizierte Ressource bereitstellt. In diesem Fall definiert die Route eine Ansicht:

   @app.route('/')
   def hello():
       """Renders a sample page."""
       return "Hello World!"
   

   Du definierst Routen, indem du den @app.route-Dekorator von Flask mit einem Argument verwendest, das die relative URL vom Stammverzeichnis der Website ist. Sie können im Code sehen, dass die Funktion nur eine Textzeichenfolge zurückgibt, die aber schon für einen Browser für das Rendern ausreicht.

4. Der untere Abschnitt enthält optionalen Code zum Starten des Flask-Entwicklungsservers. Sie können den Host und den Port über Umgebungsvariablen festlegen, anstatt sie fest zu kodieren. Mit derartigem Code können Sie die Konfiguration auf Entwicklungs- und Produktionscomputern steuern, ohne den Code ändern zu müssen:

   if __name__ == '__main__':
       import os
       HOST = os.environ.get('SERVER_HOST', 'localhost')
       try:
           PORT = int(os.environ.get('SERVER_PORT', '5555'))
       except ValueError:
           PORT = 5555
       app.run(HOST, PORT)
   

5. Klicken Sie auf Debuggen>Ohne Debuggen starten, um das Flask-Programm auszuführen und einen Browser mit dem Standardwert für Host und Port localhost:5555 zu öffnen.

Entdecken Sie Python-Vorlagen in Visual Studio

Bei der Installation des Python-Workloads stellt Visual Studio verschiedene Projektvorlagen für die Web-Frameworks Flask, Bottle und Django sowie Azure Cloud Services bereit. Außerdem gibt es Vorlagen für verschiedene Szenarien des maschinellen Lernens und eine Vorlage zur Erstellung eines Projekts aus einer vorhandenen Ordnerstruktur, die eine Python-Anwendung enthält. Sie können auf die Vorlagen zugreifen, indem Sie die Menüoption Datei>Neues>Projekt verwenden. Wählen Sie den Python-Sprachknoten und dessen untergeordnete Knoten aus, um die verfügbaren Vorlagen anzuzeigen.

Visual Studio bietet auch verschiedene Datei- und Elementvorlagen zum schnellen Erstellen einer Python-Klasse, eines Python-Pakets, eines Python-Komponententest, von web.config-Dateien usw. Wenn Sie ein Python-Projekt geöffnet haben, können Sie über die Menüoption Projekt>Neues Element hinzufügen auf Elementvorlagen zugreifen. Weitere Informationen finden Sie in der Referenz zu Elementvorlagen.

Die Verwendung von Vorlagen kann Ihnen beim Start eines Projekts oder beim Erstellen einer Datei viel Zeit sparen. Sie sind auch eine hervorragende Möglichkeit, um über verschiedene App-Typen und Codestrukturen zu erfahren. Es kann von Vorteil sein, sich etwas Zeit zu nehmen und Projekte und Elemente mit verschiedenen Vorlagen zu erstellen. So können Sie sich mit den zur Verfügung stehenden Vorlagen vertraut machen.

Cookiecutter-Vorlagen verwenden

Visual Studio bietet eine direkte Integration mit Cookiecutter, um Sie bei der Suche nach Vorlagen, der Eingabe von Vorlagenoptionen und der Erstellung von Projekten und Dateien zu unterstützen. Weitere Informationen finden Sie unter Schnellstart: Erstellen eines Projekts aus einem Artikel mit Cookiecutter-Vorlagen.

Zugehöriger Inhalt

• Tutorial: Arbeiten mit Python in Visual Studio
• Manuelles Identifizieren eines vorhandenen Python-Interpreters
• Installationsverzeichnis für Python-Tools