18. L'espace de noms intégrés de Karrigell

Cette page liste tous les noms disponibles dans les scripts Karrigell

ACCEPTED_LANGUAGES La liste des langages acceptés par le client (on peut les spécifier dans le navigateur)

AUTH_USER Nom de l'utilisateur quand on utilise l'authentification HTTP basique

AUTH_PASSWORD Mot de passe de l'utilisateur quand on utilise l'authentification HTTP basique

Authentication Fonction utilisée pour l'authentification HTTP basique

CONFIG Options de configuration, telles que définies dans la ligne de commande ou dans le fichier de configuration
Attributes

serverDir Le répertoire dans lequel se trouve le script Karrigell.py

rootDir Répertoire racine, depuis lequel les fichiers et les scripts sont servis

outputEncoding L'encodage de sortie utilisé

COOKIE Les cookies envoyés au serveur par le client. Instance de la classe SimpleCookie dans le module Python cookie

HEADERS Les entêtes de requête, envoyés par l'agent utilisateur (le navigateur) au serveur

HTTP_REDIRECTION raise HTTP_REDIRECTION,url réalise une redirection HTTP (code 302) vers l'url spécifiée

Include() Fonction utilisée pour inclure un fichier ou un script dans un autre script

Login([script_url],[role=liste_de_roles], [path=redirige_apres_connection]) Fonction utilisée pour limiter l'accès au script à des utilisateurs authentifiés. Par défaut, si l'utilisateur n'est pas déjà authentifié, une redirection est effectuée vers le script login.ks dans le répertoire racine. Un autre script peut être indiqué dans script_url. Si l'utilisateur est déjà authentifié, la fonction ne fait rien
role est la liste des rôles acceptés par le script. Par défaut prend la valeur ["admin"] ; la liste peut inclure comme autres valeurs "edit" et "visit"
path est l'url vers laquelle l'utilisateur est redirigé après une connection réussie. Par défaut il s'agit de l'url du script de départ

PATH Le chemin du script

QUERY Quand un script reçoit des données d'un formulaire, QUERY est un dictionnaire qui fait correspondre le nom des champs à leurs valeurs

REQUEST Quand un script reçoit des données d'un formulaire, QUERY est un dictionnaire qui fait correspondre le nom des champs à leurs valeurs (même chose que QUERY)

REQUEST_HANDLER Un object qui représente le gestionnaire de requête courant
Quelques attributs utiles

client_address Un tuple contenant l'adresse IP et le port du client par exemple ('127.0.0.1', 1825)

command La commande, ou méthode HTTP de la requête (habituellement GET ou POST)

encoding L'encodage tel que retourné par la fonction guess_type dans le module intégré mimetypes

RESPONSE Les entêtes de réponse envoyés par le serveur au client, tel que le Content-type

Role() Indique le rôle de l'utilisateur. S'il n'est pas encore connecté (voir Login()), la valeur est None ; sinon c'est l'une des valeurs "visit", "edit" ou "admin"

SCRIPT_END Exception pour interrompre l'exécution du script

SCRIPT_ERROR raise SCRIPT_ERROR,msg pour terminer l'exécution du script et envoyer le message msg

Session() Fonction qui retourne l'objet de session

SET_COOKIE Les cookies envoyés par le serveur au client. Instance de la classe SimpleCookie dans le module Python cookie

THIS Un objet qui représente le script courant. Les exemples supposent que le chemin du script dans le système de fichiers est C:\cygwin\home\Karrigell\webapps\demo, et qu'il est appelé par l'url demo/thisTest.pih
Attributs

basename Nom de base du script (thisTest.pih)

baseurl Partie de l'url qui précède le nom du script (demo/)

code The code source du script (ou sa conversion en code Python pour les scripts pih)

dirname Nom du répertoire (C:\cygwin\home\Karrigell\webapps\demo)

extension Extension du script (pih)

name Nom complet du script dans le système de fichiers (C:\cygwin\home\Karrigell\webapps\demo\thisTest.pih)

parent Le parent du script s'il était inclus par la fonction Include(), ou None sinon

path The chemin utilisé par le client pour accéder au script, y compris l'éventuelle "query string" (/demo/thisTest.pih)

rel() Fonction utilisée pour construire les URL correctes dans les fonctions des "services Karrigell" qui reçoivent leurs arguments sous forme d' "url intelligentes" (host/script/script.ks/foo/bar)

subpath Si le script est invoqué avec des arguments additionnels séparés par /, subpath est la liste de ces arguments (voir les "smart urls")

url L'url utilisés pour demander le script, dont on a enlevé l'éventuelle "query string" (/demo/thisTest.pih)