11.2.4 Fonctions

Fonctions dans le module cgi

Ces fonctions sont utiles si vous voulez plus de contrôle, ou si vous voulez utiliser certains des algorithmes utilisés dans ce module dans d'autres circonstances.

parse(fp)

Analyse une query string dans l'environnement ou depuis un fichier (par défaut sys.stdin).

parse_qs(qs[, conserve_valeurs_vides, analyse_stricte])

Analyse une query string donnée comme argument chaîne (données de type application/x-www-form-urlencoded). Les données sont retournée sous forme de dictionnaire. Les clés du dictionnaire sont les noms de variables uniques de la query et les valeurs sont des listes de valeurs pour chaque nom.

L'argument optionnel conserve_valeurs_vides est un indicateur qui dit s'il faut traiter les valeurs vides dans les query string URL-encodées doivent être traitées comme des chaînes vides. Une valeur vraie indique qu'il faut conserver les valeurs vides comme des chaînes vides. La valeur par défaut est fausse et indique qu'il faut ignorer les valeurs vides et les traiter comme si elles n'étaient pas incluses.

L'argument optionnel analyse_stricte est un indicateur pour dire quoi faire avec les erreurs d'analyse. S'il vaut faux (valeur par défaut), les erreurs sont ignorées sans rien dire; s'il vaut vrai, les erreurs déclenchent une exception ValueError.

parse_qsl(qs[, conserve_valeurs_vides, analyse_stricte])

Analyse une query string donnée comme argument chaîne (données de type application/x-www-form-urlencoded). Les données sont retournées sous forme d'une liste de paires nom,valeur.

parse_multipart(fp, pdict)

Analyse une donnée d'entrée de type multipart/form-data (pour les téléchargements remontants de fichiers). Les arguments sont fp pour le fichier d'entrée et pdict pour un dictionnaire contenant d'autres paramètres dans l'entête Content-Type.

Retourne un dictionnaire, exactement comme parse_qs(); les clés sont les noms de champs, chaque valeur est une liste de valeurs pour ce champs. C'est facile à utiliser mais pas très bon si vous vous attendez à ce que des mégaoctets soient chargés - dans ce cas, utilisez plutôt la classe FieldStorage qui est bien plus flexible.

Notez que cette fonction n'analyse pas les parties multipart emboîtées- pour cela, utilisez FieldStorage.

parse_header(string)

Analyse un entête MIME (tel que Content-Type) en une valeur principale et un dictionnaire de paramètres.

test()

Script de test CGI robuste, utilisable comme programme principal. Ecrit les entêtes HTTP minimaux et formatte toute l'information fournie au script sous forme HTML.

print_environ()

Formatte l'environnement du shell en HTML.

print_form(form)

Formatte un formulaire en HTML.

print_directory()

Formatte le répertoire courant en HTML.

print_environ_usage()

Imprime une liste de variables d'environnement utiles (utilisées par CGI) en HTML.

escape(s[, guillemet])

Convertit les caractères "&", "<" et ">" dans la chaîne s en séquences acceptables en HTML. A utiliser si vous devez afficher du texte susceptible de contenir de tels caractères en HTML. Si l'indicateur optionnel guillemet est vrai, le caractère double guillemet (""") est aussi traduit; c'est pratique pour inclure une valeur d'attribut HTML, par exemple dans <A HREF="...">.