ubuntuusers.de

Hinweis: Dies ist ein statischer Snapshot unseres Wikis vom 25. März 2013 und kann daher nicht bearbeitet werden. Der aktuelle Artikel ist unter wiki.ubuntuusers.de zu finden.

Bottle

Dieser Artikel wurde für die folgenden Ubuntu-Versionen getestet:

Zum Verständnis dieses Artikels sind folgende Seiten hilfreich:

bottle.png Bottle {en} ist eine in und für Python geschriebene Bibliothek (Python-Modul) zum einfachen und schnellen Erstellen von WSGI-basierten {en} (Web Server Gateway Interface) Webanwendungen. Einige Merkmale von Bottle sind:

  • besteht nur aus einer einzelnen Datei

  • hat keine Abhängigkeiten außer Python selber

  • läuft unter Python ab 2.5 und Python 3.x

  • Funktionen für das Routing - sowohl statisches als auch dynamisches Routing wird unterstützt

  • Funktionen zum Auslesen von HTML-Formulardaten und dem HTML Header

  • Funktionen zum Upload von Dateien

  • Funktionen zum Generieren und Lesen von Cookies

  • generieren eines HTML Reponse

  • eigene Vorlagen Sprache "Simple Template"

Installation

Paketquellen

Bottle ist seit Lucid Lynx in den Paketquellen enthalten[1]:

  • python-bottle

Wiki/Vorlagen/Installbutton/button.png mit apturl

Paketliste zum Kopieren:

sudo apt-get install python-bottle 

sudo aptitude install python-bottle 

Allerdings ist diese Installationsmethode nicht zu empfehlen, da in den Paketquellen nicht die aktuelle Version enthalten ist. Insbesonders die Lucid-Version ist total veraltet (0.6, aktuell Stand April 2012 ist 0.10.x), die API entspricht nicht der aktuellen.

Manuelle Installation

Bottle lässt sich einfach über easy_install[4] installieren, der Name des Python-Eggs ist "bottle".

Nutzung

Bottle bzw. dessen Funktionen und Methoden lassen sich in Python über den Aufruf von

1
2
3
import bottle
#bzw.:
from bottle import ...

in den Programmcode laden.

Routing - ein einfaches Beispiel

Das folgende Beispielprogramm zeigt kurz die Möglichkeiten von statischen und dynamischen Routen in Bottle. Dazu gibt man den Code einfach in einen Editor ein[3] und speichert diesen zum Beispiel als webanwendung.py ab.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
#!/usr/bin/env python
# -*- coding: utf-8 -*

from bottle import route, debug, run

@route('/statisch')
def statisch():
    return 'Ich bin eine statische Route'

@route('/dynamisch/:name')
def dynamisch(name):
    return 'Hallo {0}, wie geht es dir?'.format(name)

debug(True)
run()

Nun kann man seine Anwendung wie folgt im Terminal starten[2]:

python webanwendung.py 

Das Prinzip ist also wie folgt: Mit Hilfe des @route() Dekorators wird die angegebene Route an die folgende Funktion gebunden. Die Funktion wiederum kann beliebigen Python-Code enthalten, welcher letztendlich mit return zurückgegeben bzw. vom Browser dargestellt wird.

debug(True) aktiviert das Debugging und ist besonders bei der Entwicklung hilfreich, sollte bei der finalen Applikation aber wieder deaktiviert werden. run() startet den eingebauten, einfachen WSGI-Server von Bottle. Ohne weitere Parameter läuft dieser auf "localhost" und Port 8080, lässt sich aber auch leicht umkonfigurieren:

1
run(port=8081)

Routen sind dabei letztendlich die URLs, welche man aufrufen kann. Im obigen Beispiel wären dies z.B. http://localhost:8080/statisch und http://localhost:8080/dynamisch/Otto.

Wenn man aktiv am Programm entwickelt, kann run() auch mit dem Parameter reloader aufgerufen werden, also:

1
run(reloader=True)

Damit wird das Programm bei Änderungen automatisch neu geladen, ohne das man den Server manuell stoppen und starten muss.

Simple Template

Im folgenden wird ein einfaches Beispiel für die in Bottle enthaltene Vorlagensprache "Simple Template" gezeigt.

Zuerst wird eine Route definiert:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
#!/usr/bin/env python
# -*- coding: utf-8 -*

from bottle import route, debug, run, template

@route('/vorlage/:zahl')
def vorlage(zahl):
    return template('bsp.tpl',zahl=zahl)

debug(True)
run(reloader=True)

Dies erwartet, dass es eine Vorlage bsp.tpl gibt, welche entweder im gleichen Ordner wie das Python Programm oder im Unterordnder ./views liegt. An die Vorlage wird aus der dynamischen Route der Wert für zahl übergeben, welcher dann in der Vorlage ebenfalls unter der Variablen zahl vorhanden ist.

Die Vorlagen-Datei sieht so aus:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
%#Eine einfache Vorlage mit Simple Template
<h1>Vervielfachen</h1>
%try:
    %wert = int(zahl)
    <p>Die eingegebenen Zahl ist {{wert}}</p>
    %for i in (2,4,6):
        %vielfach = i*wert
        <p>Das {{i}}-fache davon ist {{vielfach}}</p>
    %end
%except ValueError:
    <p>{{zahl}} ist keine Zahl!</p>
%end
<p>Fertig!</p>

Wie man sieht ist dies eine Mischung aus HTML und Python. Python-Zeilen werden mit dem Prozentzeichen % eingeleitet und können grundsätzlich beliebigen, gültigen Python-Code enthalten. Will man Variablen in der Vorlage auch außerhalb der Python-Zeilen nutzen, so müssen diese in doppelte geschweifte Klammern {{ }} eingeschlossen werden. Eine Besonderheit ist, dass - anders als in "reinem" Python - Schleifen u.ä. explizit mit %end abgeschlossen werden müssen. Neben HTML kann das Template auch beliebigen anderen Code enthalten (z.B. JavaScript), solange der Webbrowser diesen darstellen kann.

Eine vollständige Übersicht über Simple Template findet man in der Dokumentation {en}.

Anbindung an andere Server

Bottle kann natürlich auch mit weiteren, "echten" Webservern genutzt werden (u.a. auch mit dem Apache via mod_wsgi), nicht nur mit dem internen Server. Eine ausführliche Beschreibung findet man in der Anleitung {en} zu Bottle im Internet.

Weitere Funktionen

Die hier aufgeführten Beispiele zeigen nur einen Teil der Funktionalität von Bottle. Eine komplette Übersicht und Anleitung findet man in der Dokumentation {en} von Bottle.

Alternativen

Flask {en} ist ein weiteres WSGI Microframework, im direkten Vergleich zu Bottle etwas größer und komplexer, bietet aber auch mehr Möglichkeiten.

ubuntuusers.local › WikiBottle