Sdílet prostřednictvím


Šablony projektů webových aplikací v Pythonu

Python v sadě Visual Studio podporuje vývoj webových projektů v architekturách Bottle, Flask a Django prostřednictvím šablon projektů a spouštěče ladění, který lze nakonfigurovat pro zpracování různých architektur. Mezi tyto šablony patří soubor requirements.txt , který deklaruje nezbytné závislosti. Při vytváření projektu z jedné z těchto šablon vás Visual Studio vyzve k instalaci závislých balíčků, jak je popsáno v požadavcích na instalaci dále v tomto článku.

Můžete také použít obecnou šablonu webového projektu pro jiné architektury, jako je pyramida. V tomto případě se se šablonou nenainstalují žádné architektury. Místo toho nainstalujete potřebné balíčky do prostředí, které používáte pro projekt. Další informace najdete v okně prostředí Pythonu – karta Balíček.

Možnosti šablony projektu

Projekt ze šablony vytvoříte tak, že v nabídce panelu nástrojů vyberete Soubor>nový>projekt. V dialogovém okně Vytvořit nový projekt můžete vyfiltrovat seznam šablon a zobrazit možnosti dostupné pro webové projekty Pythonu. Zadejte klíčové termíny do vyhledávacího pole nebo pomocí rozevíracích nabídek filtru vyberte Python jako jazyk a web jako typ projektu.

Snímek obrazovky s dialogovým oknem Vytvořit nový projekt se šablonami filtrovanými pro zobrazení možností pro webové aplikace v Pythonu v sadě Visual Studio

Po výběru šablony zadáte název projektu a řešení a nastavíte možnosti pro adresář řešení a úložiště Git.

Obecná šablona webového projektu poskytuje prázdný projekt sady Visual Studio bez kódu a neposkytuje žádné předpoklady, než je projekt Pythonu. Ostatní šablony jsou založené na webových architekturách Bottle, Flask nebo Django a seskupené do tří kategorií, jak je popsáno v následujících částech. Aplikace vytvořené některou z těchto šablon obsahují dostatečný kód pro místní spuštění a ladění aplikace. Každá šablona také poskytuje potřebný objekt aplikace WSGI (python.org) pro použití s produkčními webovými servery.

Prázdná skupina

Všechny šablony webového projektu prázdné <architektury> vytvářejí projekt s více nebo méně minimálním často používaným kódem a nezbytnými závislostmi deklarovanými v souboru requirements.txt.

Template Popis
Prázdný webový projekt Bottle Vygeneruje minimální aplikaci v souboru app.py s domovskou stránkou pro / umístění a /hello/<name> stránku, která vrací <name> hodnotu pomocí krátké vložené šablony stránky.
Prázdný webový projekt Django Vygeneruje projekt Django s základní strukturou webu Django, ale žádné aplikace Django. Další informace naleznete v tématu Šablony Django a Learn Django Krok 1.
Prázdný webový projekt Flask Vygeneruje minimální aplikaci s jedinou stránkou Hello World pro / umístění. Tato aplikace se podobá výsledku následujících podrobných kroků v rychlém startu: Pomocí sady Visual Studio vytvořte svou první webovou aplikaci v Pythonu. Další informace najdete v tématu Learn Flask Step 1.

Webová skupina

Všechny <šablony webového projektu architektury> vytvářejí úvodní webovou aplikaci se stejným návrhem bez ohledu na zvolenou architekturu. Aplikace má stránky Domů, O aplikaci a Kontakt a navigační panel nabídek a responzivní návrh, který používá Bootstrap. Každá aplikace je správně nakonfigurovaná tak, aby obsluhovala statické soubory (CSS, JavaScript a písma) a používá mechanismus šablony stránky vhodný pro architekturu.

Template Popis
Webový projekt Bottle Vygeneruje aplikaci, jejíž statické soubory jsou obsaženy ve statické složce, a zpracovává prostřednictvím kódu v souboru app.py . Směrování jednotlivých stránek je obsaženo v souboru routes.py . Složka zobrazení obsahuje šablony stránek.
Webový projekt Django Generuje projekt Django a aplikaci Django se třemi stránkami, podporou ověřování a databází SQLite (ale bez datových modelů). Další informace naleznete v tématu Šablony Django a Learn Django Krok 4.
Webový projekt Flask Vygeneruje aplikaci, jejíž statické soubory jsou obsaženy ve statické složce. Kód v souboru views.py zpracovává směrování pomocí šablon stránek, které používají modul Jinja obsažený ve složce šablon . Soubor runserver.py poskytuje spouštěcí kód.

Požadavky na instalaci

Při vytváření projektu ze šablony specifické pro architekturu poskytuje Visual Studio dialogové okno, které vám pomůže nainstalovat potřebné balíčky pomocí nástroje pip. Doporučujeme také použít virtuální prostředí pro webové projekty, abyste zajistili, že při publikování webu budou zahrnuté správné závislosti:

Snímek obrazovky znázorňující dialogové okno pro instalaci balíčků pro šablonu projektu v sadě Visual Studio

Pokud používáte správu zdrojového kódu, obvykle vynecháte složku virtuálního prostředí, protože toto prostředí lze znovu vytvořit pomocí pouze requirements.txt souboru. Nejlepší způsob, jak vyloučit složku, je nejprve vybrat možnost Já je nainstaluji sám , a pak zakázat automatické potvrzení před vytvořením virtuálního prostředí. Další informace najdete v tématu Prozkoumání ovládacích prvků Git v kurzu Learn Django a Learn Flask.

Když nasadíte do služby Microsoft Aplikace Azure Service, vyberte jako rozšíření webu verzi Pythonu a ručně nainstalujte balíčky. Vzhledem k tomu, že služba Aplikace Azure Service při nasazení ze sady Visual Studio automaticky neinstaluje balíčky ze souboru requirements.txt, postupujte podle podrobností o konfiguraci aka.ms/PythonOnAppService.

Možnosti ladění

Když otevřete webový projekt pro ladění, Visual Studio spustí místní webový server na náhodném portu a otevře výchozí prohlížeč na tuto adresu a port. Pokud chcete zadat další možnosti, klikněte pravým tlačítkem myši na projekt v Průzkumník řešení a vyberte Vlastnosti. Na stránce Vlastnosti vyberte kartu Ladění.

Snímek obrazovky znázorňující vlastnosti spouštěče webů pro obecnou webovou šablonu v sadě Visual Studio

Existují tři skupiny běžných možností konfigurace pro ladění projektu. Skupina Spustit obsahuje následující vlastnosti:

  • Možnosti Cesty hledání, argumenty skriptu, cesta interpretu a argumenty interpretu jsou stejné jako pro běžné ladění.
  • Adresa URL pro spuštění určuje adresu URL, která se otevře v prohlížeči. Výchozí umístění je localhost.
  • Číslo portu identifikuje port, který se má použít, pokud v adrese URL není zadán žádný (Visual Studio ho ve výchozím nastavení vybere automaticky). Toto nastavení umožňuje přepsat výchozí hodnotu SERVER_PORT proměnné prostředí, kterou používají šablony ke konfiguraci portu, na kterém místní ladicí server naslouchá.
  • Seznam prostředí definuje proměnné, které se mají nastavit v procesu vytvoření. Formát je seznam dvojic oddělených <NAME>=<VALUE> novým řádekem.

Vlastnosti ve skupinách Příkazů spustit server a příkazový příkaz ladicího serveru určují způsob spuštění webového serveru. Vzhledem k tomu, že mnoho architektur vyžaduje použití skriptu mimo aktuální projekt, lze skript nakonfigurovat zde a název spouštěcího modulu lze předat jako parametr.

  • Příkazemmůže být skript Pythonu (*.py soubor), název modulu (jako v, python.exe -m module_name) nebo jeden řádek kódu (jako v, python.exe -c "code"). Hodnota v rozevíracím seznamu označuje, který typ je určen.
  • Seznam argumentů se předává na příkazovém řádku za příkazem.
  • Seznam prostředí znovu definuje proměnné, které se mají nastavit po všech vlastnostech, které můžou prostředí upravit, například číslo portu a cesty hledání. Tyto hodnoty proměnných mohou přepsat jiné hodnoty vlastností.

Libovolnou vlastnost projektu nebo proměnnou prostředí lze zadat pomocí syntaxe NÁSTROJE MSBuild, například $(StartupFile) --port $(SERVER_PORT). $(StartupFile) je relativní cesta ke spouštěcímu souboru a {StartupModule} je importovatelný název spouštěcího souboru. $(SERVER_HOST) a $(SERVER_PORT) jsou normální proměnné prostředí, které jsou nastaveny vlastností Launch URL a Port Number , automaticky nebo environment vlastnost.

Poznámka:

Hodnoty v příkazu Spustit server se používají s příkazem Start Server ladění>nebo klávesovou zkratkou Ctrl+F5. Hodnoty ve skupině příkazů ladicího serveru se používají s příkazem Ladění>spustit ladicí server nebo F5.

Ukázková konfigurace bottle

Šablona webového projektu Bottle Obsahuje často používaný kód, který provede potřebnou konfiguraci. Importovaná aplikace lahví ale nemusí obsahovat tento kód, v takovém případě se aplikace spustí pomocí nainstalovaného bottle modulu:

  • Spusťte skupinu příkazů serveru:

    • Příkaz: bottle (modul)
    • Argumenty: --bind=%SERVER_HOST%:%SERVER_PORT% {StartupModule}:app
  • Skupina příkazů ladění serveru:

    • Příkaz: bottle (modul)
    • Argumenty--debug --bind=%SERVER_HOST%:%SERVER_PORT% {StartupModule}:app

Tato --reload možnost se nedoporučuje při použití sady Visual Studio pro ladění.

Ukázková konfigurace jehlanu

Jehlanové aplikace jsou v současné době nejvhodnější pro vytváření pomocí nástroje příkazového pcreate řádku. Po vytvoření aplikace ji můžete importovat pomocí existující šablony kódu Pythonu. Po dokončení importu vyberte přizpůsobení obecného webového projektu a nakonfigurujte možnosti. Tato nastavení předpokládají, že je pyramida nainstalovaná do virtuálního prostředí v ..\env umístění.

  • Spustit skupinu:

    • Číslo portu: 6543 (nebo cokoli je nakonfigurované v souborech .ini )
  • Spusťte skupinu příkazů serveru:

    • Příkaz: ..\env\scripts\pserve-script.py (skript)
    • Argumenty: Production.ini
  • Skupina příkazů ladění serveru:

    • Příkaz: ..\env\scripts\pserve-script.py (skript)
    • Argumenty: Development.ini

Tip

Pravděpodobně budete muset nakonfigurovat vlastnost Pracovní adresář projektu, protože aplikace Pyramid jsou obvykle jedna složka pod kořenem projektu.

Další konfigurace

Pokud máte nastavení pro jinou architekturu, kterou chcete sdílet, nebo pokud chcete požádat o nastavení pro jinou architekturu, otevřete problém na GitHubu.