Szablony projektów aplikacji internetowych w języku Python

Język Python w programie Visual Studio obsługuje tworzenie projektów internetowych w platformach Bottle, Flask i Django za pomocą szablonów projektów oraz uruchamiania debugowania, które można skonfigurować do obsługi różnych struktur. Te szablony zawierają plik requirements.txt w celu zadeklarowania niezbędnych zależności. Podczas tworzenia projektu na podstawie jednego z tych szablonów program Visual Studio monituje o zainstalowanie pakietów zależnych zgodnie z opisem w temacie Wymagania dotyczące instalacji w dalszej części tego artykułu.

Możesz również użyć ogólnego szablonu projektu internetowego dla innych struktur, takich jak Piramida. W takim przypadku żadne struktury nie są instalowane z szablonem. Zamiast tego należy zainstalować niezbędne pakiety w środowisku używanym dla projektu. Aby uzyskać więcej informacji, zobacz okno Środowiska języka Python — karta Pakiet.

Opcje szablonu projektu

Projekt można utworzyć na podstawie szablonu, wybierając pozycję Plik>nowy>projekt z menu paska narzędzi. W oknie dialogowym Tworzenie nowego projektu można filtrować listę szablonów, aby wyświetlić opcje dostępne dla projektów internetowych języka Python. Wprowadź kluczowe terminy w polu Wyszukaj lub użyj menu rozwijanych filtru, aby wybrać język Python jako język i sieć Web jako typ projektu.

Po wybraniu szablonu należy podać nazwę projektu i rozwiązania oraz ustawić opcje katalogu rozwiązania i repozytorium Git.

Ogólny szablon projektu internetowego zawiera pusty projekt programu Visual Studio bez kodu i nie przyjmuje żadnych założeń innych niż projekt w języku Python. Inne szablony są oparte na platformach internetowych Bottle, Flask lub Django i pogrupowane w trzy kategorie, zgodnie z opisem w poniższych sekcjach. Aplikacje utworzone przez dowolny z tych szablonów zawierają wystarczający kod do uruchamiania i debugowania aplikacji lokalnie. Każdy szablon udostępnia również niezbędny obiekt aplikacji WSGI (python.org) do użycia z produkcyjnymi serwerami internetowymi.

Pusta grupa

Wszystkie szablony projektów <sieci Web w ramach pustej struktury> tworzą projekt z co najmniej minimalnym kodem standardowy i niezbędnymi zależnościami zadeklarowanymi w pliku requirements.txt.

Szablon	opis
Pusty projekt sieci Web butelki	Generuje minimalną aplikację w pliku app.py ze stroną / główną lokalizacji i /hello/<name> stroną, która odzwierciedla <name> wartość przy użyciu krótkiego szablonu strony wbudowanej.
Pusty projekt internetowy Django	Generuje projekt Django z podstawową strukturą witryny Django, ale bez aplikacji Django. Aby uzyskać więcej informacji, zobacz Szablony Django i Learn Django Step 1.
Pusty projekt internetowy platformy Flask	Generuje minimalną aplikację z pojedynczą stroną "Hello World!" dla / lokalizacji. Ta aplikacja jest podobna do wyniku wykonania szczegółowych kroków w przewodniku Szybki start: tworzenie pierwszej aplikacji internetowej w języku Python przy użyciu programu Visual Studio. Aby uzyskać więcej informacji, zobacz Learn Flask Step 1 (Learn Flask Step 1).

Grupa sieci Web

Wszystkie <szablony projektów internetowych platformy> tworzą początkową aplikację internetową o identycznym projekcie niezależnie od wybranej platformy. Aplikacja ma strony Strona główna, Informacje i Kontakt wraz z paskiem menu nawigacji i dynamicznym projektem korzystającym z narzędzia Bootstrap. Każda aplikacja jest odpowiednio skonfigurowana do obsługi plików statycznych (CSS, JavaScript i czcionek) i używa mechanizmu szablonu strony odpowiedniego dla platformy.

Szablon	opis
Projekt sieci Web butelki	Generuje aplikację, której pliki statyczne znajdują się w folderze statycznym i są obsługiwane za pomocą kodu w pliku app.py . Routing dla poszczególnych stron jest zawarty w pliku routes.py . Folder views zawiera szablony stron.
Projekt internetowy Django	Generuje projekt Django i aplikację Django z trzema stronami, obsługą uwierzytelniania i bazą danych SQLite (ale bez modeli danych). Aby uzyskać więcej informacji, zobacz Szablony Django i Learn Django Step 4.
Projekt internetowy platformy Flask	Generuje aplikację, której pliki statyczne znajdują się w folderze statycznym. Kod w pliku views.py obsługuje routing za pomocą szablonów stron korzystających z aparatu Jinja zawartego w folderze templates . Plik runserver.py zawiera kod uruchamiania.

Wymagania dotyczące instalacji

Podczas tworzenia projektu na podstawie szablonu specyficznego dla platformy program Visual Studio udostępnia okno dialogowe ułatwiające zainstalowanie niezbędnych pakietów przy użyciu narzędzia. Zalecamy również używanie środowiska wirtualnego dla projektów internetowych, aby upewnić się, że podczas publikowania witryny sieci Web są uwzględniane poprawne zależności:

Jeśli używasz kontroli źródła, zazwyczaj pomijasz folder środowiska wirtualnego, ponieważ to środowisko można odtworzyć tylko przy użyciu pliku requirements.txt . Najlepszym sposobem wykluczenia folderu jest najpierw wybranie opcji Zainstaluję je samodzielnie , a następnie wyłączenie automatycznego zatwierdzania przed utworzeniem środowiska wirtualnego. Aby uzyskać więcej informacji, zobacz Sprawdzanie kontrolek Git w samouczku learn Django i learn Flask Tutorial.

Podczas wdrażania w usłudze Microsoft aplikacja systemu Azure wybierz wersję języka Python jako rozszerzenie lokacji i ręcznie zainstaluj pakiety. Ponadto, ponieważ usługa aplikacja systemu Azure nie instaluje automatycznie pakietów z pliku requirements.txt podczas wdrażania z programu Visual Studio, postępuj zgodnie ze szczegółami konfiguracji aka.ms/PythonOnAppService.

Opcje debugowania

Po otwarciu projektu internetowego na potrzeby debugowania program Visual Studio uruchamia lokalny serwer internetowy na losowym porcie i otwiera domyślną przeglądarkę dla tego adresu i portu. Aby określić więcej opcji, kliknij prawym przyciskiem myszy projekt w Eksplorator rozwiązań, wybierz pozycję Właściwości. Na stronie Właściwości wybierz kartę Debugowanie.

Istnieją trzy grupy typowych opcji konfiguracji do debugowania projektu. Grupa Uruchom zawiera następujące właściwości:

• Ścieżki wyszukiwania, argumenty skryptu, ścieżka interpretera i argumenty interpretera są takie same jak w przypadku normalnego debugowania.
• Adres URL uruchamiania określa adres URL otwierany w przeglądarce. Domyślną lokalizacją jest localhost.
• Numer portu identyfikuje port do użycia, jeśli żaden z nich nie jest określony w adresie URL (program Visual Studio domyślnie wybiera jeden automatycznie). To ustawienie umożliwia zastąpienie domyślnej wartości SERVER_PORT zmiennej środowiskowej, która jest używana przez szablony do konfigurowania portu, na którym nasłuchuje lokalny serwer debugowania.
• Lista Środowisko definiuje zmienne, które mają być ustawiane w procesie zduplikowanego. Format jest nową listą <NAME>=<VALUE> par rozdzielanych liniami.

Właściwości w grupach Uruchom polecenie serwera i Polecenie debugowania serwera określają sposób uruchamiania serwera internetowego. Ponieważ wiele struktur wymaga użycia skryptu poza bieżącym projektem, skrypt można skonfigurować tutaj i nazwę modułu uruchamiania można przekazać jako parametr.

• Polecenie może być skryptem języka Python (*.py pliku), nazwą modułu (jak w, python.exe -m module_name), lub pojedynczym wierszem kodu (jak w, python.exe -c "code"). Wartość w polu listy rozwijanej wskazuje, który typ ma być przeznaczony.
• Lista argumentów jest przekazywana w wierszu polecenia po poleceniu .
• Ponownie lista Środowisko definiuje zmienne ustawiane po wszystkich właściwościach, które mogą modyfikować środowisko, takie jak numer portu i ścieżki wyszukiwania. Te wartości zmiennych mogą zastąpić inne wartości właściwości.

Każdą właściwość projektu lub zmienną środowiskową można określić za pomocą składni MSBuild, takiej jak $(StartupFile) --port $(SERVER_PORT). $(StartupFile) jest ścieżką względną do pliku uruchamiania i {StartupModule} jest importowalnym nazwą pliku uruchamiania. $(SERVER_HOST) i $(SERVER_PORT) są normalnymi zmiennymi środowiskowymi, które są ustawiane przez właściwości Adres URL uruchamiania i Numer portu, automatycznie lub według właściwości Środowisko .

Uwaga

Wartości w Run Server Command są używane z poleceniem Debug>Start Server lub skrót klawiaturowy Ctrl+F5. Wartości w grupie Polecenia serwera debugowania są używane z poleceniem Debuguj>uruchom debugowanie serwera lub F5.

Przykładowa konfiguracja butelki

Szablon Bottle Web Project zawiera standardowy kod, który wykonuje wymaganą konfigurację. Zaimportowana aplikacja butelki może nie zawierać tego kodu, jednak w takim przypadku następujące ustawienia uruchamiają aplikację przy użyciu zainstalowanego bottle modułu:

• Uruchom grupę poleceń serwera:

  • Polecenie: bottle (moduł)
  • Argumenty: --bind=%SERVER_HOST%:%SERVER_PORT% {StartupModule}:app

• Grupa poleceń serwera debugowania :

  • Polecenie: bottle (moduł)
  • Argumenty --debug --bind=%SERVER_HOST%:%SERVER_PORT% {StartupModule}:app

Opcja nie jest zalecana --reload w przypadku korzystania z programu Visual Studio do debugowania.

Przykładowa konfiguracja ostrosłupów

Aplikacje ostrosłupowe są obecnie najlepiej tworzone przy użyciu pcreate narzędzia wiersza polecenia. Po utworzeniu aplikacji można ją zaimportować przy użyciu szablonu Z istniejącego kodu języka Python. Po zakończeniu importowania wybierz dostosowanie ogólnego projektu internetowego, aby skonfigurować opcje. Te ustawienia zakładają, że Piramida jest zainstalowana w środowisku wirtualnym w ..\env lokalizacji.

• Uruchom grupę:

  • Numer portu: 6543 (lub cokolwiek jest skonfigurowane w plikach .ini )

• Uruchom grupę poleceń serwera:

  • Polecenie: ..\env\scripts\pserve-script.py (skrypt)
  • Argumenty: Production.ini

• Grupa poleceń serwera debugowania :

  • Polecenie: ..\env\scripts\pserve-script.py (skrypt)
  • Argumenty: Development.ini

Napiwek

Prawdopodobnie musisz skonfigurować właściwość Katalog roboczy projektu, ponieważ aplikacje Pyramid są zazwyczaj jednym folderem poniżej katalogu głównego projektu.

Inne konfiguracje

Jeśli masz ustawienia dla innej platformy, którą chcesz udostępnić, lub jeśli chcesz zażądać ustawień dla innej platformy, otwórz problem w usłudze GitHub.

Powiązana zawartość

• Dokumentacja szablonów elementów języka Python
• Wybieranie środowiska języka Python dla projektu w programie Visual Studio