W tym rozdziale, podobnie jak i innych rozdziałach dotyczących aplikacji webowych w Pythonie, będę używał Pycharm w wersji Professional ze względu na wsparcie dla Flaska i Django. Można pobrać wersję trial na potrzeby nauki, ale do profesjonalnej pracy proponuję faktycznie wykupić subskrypcję. Wprawdzie kosztuje ona niecałe 200zł miesięcznie, ale przyspiesza pracę tak bardzo, że moim zdaniem warto. Inna sprawa – profesjonalny rysownik też nie używa produkcyjnie darmowych ołówków z Ikei.
Jeśli wybrałeś proponowane przeze mnie oprogramowanie, to tworząc nowy projekt powinieneś mieć taki mniej więcej widok:
W zasadzie jedyne co trzeba tu zrobić to nadać nazwę projektowi – ja nadałem nazwę „flask_mapet”. W projekcie powinien zostać stworzony plik „app.py” który będzie naszym głównym plikiem uruchomieniowym. Jego zawartość poniżej:
Co oznaczają poszczególne elementy? Linia 1 – importujemy klasę „Flask” z modułu „flask” którą będziemy wykorzystywać za chwilę. Linia 3 – konieczne jest stworzenie instancji obiektu modułu Flask, ponieważ później się do niego odnosimy na przykład uruchamiając apkę (w linii 12) czy w @app.route (w linii 6). Konstruktor oczekuje podania nazwy aplikacji jako parametru.
Linie 6-8. W linii 6 używamy dekoratora pozwalającego nam zadeklarować mapowany przez funkcję url (czyli w reakcji na jaki adres http w ramach naszej aplikacji ma odpowiadać dana funkcja). Wartość argumentu: „/” oznacza że poniższa funkcja będzie mapować stronę główną. Funkcja nie przyjmuje żadnych argumentów. Zwraca za to w linii 8 kod który ma zostać wyświetlony w reakcji na wejście na url mapowany przez funkcję.
Linie 11-12. To jest kod zapewniający że serwer jest uruchamiany kiedy odpalamy plik app.py będący głównym skryptem aplikacji. W zasadzie chodzi o wywołanie funkcji „run()” na obiekcie instancji obiektu modułu Flask. Warunek służy temu, by nie następowały kolejne próby uruchamiania w sytuacji gdyby np. ten moduł był importowany. Jeśli to skrypt „app.py” będzie uruchamiany, to w „__name__” dostaniemy „__main__”.
Aplikację możemy uruchomić z konsoli wywołując skrypt jak każdy inny:
Flask ma wbudowany własny serwer http, będzie on domyslnie chodził na porcie 5000. Po wejściu przez przeglądarkę na ten port powinniśmy zobaczyć wynik działania funkcji „hello_world” która obsługuje główną stronę aplikacji:
Odrobinę zmodyfikuję teraz skrypt „app.py”:
Dodałem argumenty do wywołania funkcji run. Parametr „port” pozwala ustawić na którym porcie ma nasłuchiwać serwer. Zmieniam na 80 by móc wywoływać aplikację po prostu „localhost” zamiast „localhost:5000”. Parametr „debug” powoduje, że zmiany na plikach z kodem będą od razu aktualizowane na serwerze, bez potrzeby restartu. Poniżej przykład takiego przeładowania. To jest zrzut logów. Dodałem do skryptu enter, zapisałem i aplikacja została przeładowana:
Funkcja obsługująca mapowanie adresu może zamiast zwykłego tekstu, zwracać również kod HTML:
Efekt działania:
Na dłuższą metę, lub przy większej ilości kodu takie działanie będzie po prostu bardzo niewygodne. Wyobraź sobie 1000 linijkową stronę generowaną w ten sposób. Biorąc jeszcze pod uwagę że zwykle będą jakieś elementy wspólne na wielu podstronach, a podmieniana będzie tylko jakaś nieduża część widoku, to jest to całkowicie pozbawione sensu. Co więc możemy zrobić? Wykorzystać szablon HTML:
Wykorzystamy funkcję „render_template”(linia 12) którą trzeba uprzednio zaimportować (linia 1). Funkcja jako argument będzie przyjmowała nazwę pliku który ma zostać pokazany. Co ważne, plik ten musi znajdować się w podkatalogu „templates”, ponieważ Flask tam właśnie będzie go szukał.
Efekt działania:
Wszystko pięknie, ale widok ten jest statyczny. Jak zatem przekazać dane do widoku? Kod z poprzedniego przykładu nieco przerobiłem. Do funkcji „render_template” poza samą nazwą widoku, przekazuję też dwie zmienne: imię i nazwisko. Pod takimi nazwami zostaną do widoku przekazane dane. Typ danych nie ma tu wielkiego znaczenia, jeśli okazałoby się że jest to kolekcja, różnica będzie tylko w sposobie wyświetlania.
Mała przeróbka po stronie szablonu HTML:
Pomiędzy podwójnymi klamrami umieszczamy nazwę pod jaką przekazaliśmy dane do widoku w argumentach funkcji „render_template”. Efekt działania:
To są pojedyncze zmienne. Jak jednak przekazać listę, a następnie przeiterować po niej na poziomie widoku? W pierwszej kolejności modyfikuję funkcję by przekazać dane:
Utworzyłem sobie listę krajów którą przekazałem wraz z imieniem i nazwiskiem do widoku. Po stronie widoku korzystam ze składni jinja2:
Wynik działania:
Zaraz, zaraz… jinja? Jinja2 to silnik szablonów dla Pythona. Taki powiedzmy mikro język skryptowy który umożliwia nam zawieranie pewnej logiki biznesowej po stronie widoku. Daje nam możliwość wyświetlania danych przekazanych do render_template, iterowanie po listach na poziomie widoków, warunkowe wykonywanie czynności, a także kilka innych możliwości które omówimy nieco później.
Sama Jinja2 to osobna biblioteka którą musicie dodać do projektu wykonując „pip install jinja2”. Jeśli korzystacie z Pycharm Professional, nie musicie się o to marwić bo IDE zadbało już o to za Was. Gdyby Pycharm podkreślał Ci składnię jinja2, upewnij się że Jinja2 znajduje się w venv projektu:
Wracając jednak do składni:
Iterujemy po liście o nazwie „kraje”, ponieważ pod taką nazwą została przekazana nasza lista.
Odwołujemy się potem do tej listy w linii 7 naszego kodu HTML we fragmencie „for k in kraje”. Klamry i znaczniki „%” są elementem tej składni. Fragment „for k in ….” to deklaracja w jaki sposób będę się odnosił w pętli do elementów po których iteruję. Wewnątrz pętli posługuję się notacją taką jak przy wyświetleniu zwykłych zmiennych „{{ k }}”, z tą różnicą że odnoszę się do lokalnego „k”. Nie zapominamy też o „{% endfor %} który zamyka pętlę. Efekt działania:
Jinja2 umożliwia też warunkowe wykonanie. Poniżej przykład pewnego wariantu naszej aplikacji. Postanowiłem że na liście „Polska” ma być pogrubiona:
We wnętrzu naszej pętli umieściłem jeszcze blok warunkowy. Jeśli przetwarzany element będzie równy ciągowi tekstowemu „Polska”, wyświetlany element będzie dodatkowo otoczony takami „<b>” i „</b>”. Efekt działania:
Taka instrukcja warunkowa może przyjmować oczywiście więcej wariantów, podobnie jak w czysto pythonowym ifie. W poniższym przykładzie Rosja zostanie podkreślona:
Efekt działania:
