Utilitaires Django

Ce document présente tous les modules stables dans django.utils. La plupart des modules dans django.utils sont conçus pour un usage interne et seuls les parties documentées ici peuvent être considérées comme stables et donc rétrocompatibles, selon la politique interne d’obsolescence de publication.

django.utils.cache

Ce module contient des fonctions utilitaires pour le contrôle du cache. Il opère en manipulant l’en-tête Vary des réponses. Il contient des fonctions pour modifier directement l’en-tête des objets réponse ainsi que des décorateurs qui modifient les fonctions afin qu’elle se chargent elles-mêmes de la modification des en-têtes.

Pour plus d’informations sur l’en-tête Vary, voir la RFC 7231#section-7.1.4.

À la base, l’en-tête HTTP Vary définit quels en-têtes de requête un cache doit prendre en considération pour générer sa clé de cache. Les requêtes vers un même chemin mais contenant des contenus d’en-tête différents pour les en-têtes mentionnés dans Vary ont besoin de produire des clés de cache différentes pour ne pas délivrer de mauvais contenu.

Par exemple, l’intergiciel d”internationalisation doit pouvoir mettre en cache des versions différentes en fonction de l’en-tête Accept-language.

patch_cache_control(response, **kwargs)[source]

Cette fonction complète l’en-tête Cache-Control en y ajoutant tous les paramètres nommés. La transformation se fait comme suit :

  • Tous les paramètres nommés sont transformés en minuscules et les soulignements sont convertis en tirets.
  • Si la valeur d’un paramètre est True (exactement True, pas seulement une valeur évaluée à True), seul le nom du paramètre est ajouté à l’en-tête.
  • Tous les autres paramètres sont ajoutés avec leur valeur, après avoir passé par la fonction str().
get_max_age(response)[source]

Renvoie la valeur max-age de l’en-tête de réponse Cache-Control sous forme de nombre entier (ou None s’il n’existe pas ou qu’il n’est pas un nombre entier).

patch_response_headers(response, cache_timeout=None)[source]

Ajoute certains en-têtes utiles à l’objet HttpResponse donné :

  • ETag
  • Expires
  • Cache-Control

Chaque en-tête n’est ajouté que s’il n’est pas déjà présent.

cache_timeout est en secondes. Le réglage CACHE_MIDDLEWARE_SECONDS est utilisé par défaut.

Changed in Django 1.11:

Dans les versions précédentes, l’en-tête Last-Modified était aussi défini.

Obsolète depuis la version 1.11: Comme le réglage USE_ETAGS est obsolète, cette fonction ne définira plus l’en-tête ETag lorsque la période d’obsolescence se terminera avec Django 2.1.

add_never_cache_headers(response)[source]

Ajoute un en-tête Cache-Control: max-age=0, no-cache, no-store, must-revalidate à une réponse pour indiquer que la page ne doit jamais être mise en cache.

patch_vary_headers(response, newheaders)[source]

Ajoute (ou met à jour) l’en-tête Vary dans l’objet HttpResponse donné. newheaders est une liste de noms d’en-têtes qui doivent se trouver dans Vary. Les en-têtes existants dans Vary ne sont pas enlevés.

get_cache_key(request, key_prefix=None)[source]

Renvoie une clé de cache basée sur le chemin de requête. Cette méthode peut être utilisée dans la phase de requête car elle extrait la liste d’en-têtes à prendre en compte à partir du registre global de chemin et utilise ces en-têtes pour construire une clé de cache à utiliser.

Si aucune liste d’en-tête n’est stockée, la page doit être reconstruite et cette fonction renvoie donc None.

learn_cache_key(request, response, cache_timeout=None, key_prefix=None)[source]

Apprend quels en-têtes à prendre en compte pour un certain chemin de requête à partir de l’objet réponse. Elle stocke ces en-têtes dans un registre global de chemins afin que tout accès ultérieur à ce chemin sache les en-têtes à prendre en compte sans devoir construire l’objet réponse lui-même. Les en-têtes sont nommés dans l’en-tête Vary de la réponse, mais il s’agit d’éviter de devoir générer la réponse.

La liste des en-têtes à utiliser pour la génération de la clé de cache est stockée dans le même cache que les pages elles-mêmes. Si le cache rejette certaines vieilles données du cache, cela signifie simplement qu’il faut reconstruire une fois la réponse pour avoir accès à l’en-tête Vary et par là à la liste des en-têtes à utiliser pour la clé de cache.

django.utils.dateparse

Les fonctions définies dans ce module partagent les propriétés suivantes :

  • Elles génèrent une exception ValueError si la valeur d’entrée est correctement mise en forme mais qu’elle ne correspond pas à une date ou heure valable.
  • Elles renvoient None si la valeur d’entrée n’est pas correctement mise en forme.
  • Elles acceptent une résolution de valeur d’entrée jusqu’à la picoseconde, mais elles tronquent à la microseconde car c’est la résolution maximale gérée par Python.
parse_date(value)[source]

Analyse une chaîne et renvoie un objet datetime.date.

parse_time(value)[source]

Analyse une chaîne et renvoie un objet datetime.time.

Les décalages UTC ne sont pas pris en charge ; si value en contient un, le résultat sera None.

parse_datetime(value)[source]

Analyse une chaîne et renvoie un objet datetime.datetime.

Les décalages UTC sont pris en charge ; si value en contient un, l’attribut tzinfo du résultat sera une instance FixedOffset.

parse_duration(value)[source]

Analyse une chaîne et renvoie un objet datetime.timedelta.

S’attend à recevoir des données au format "JJ HH:MM:SS.uuuuuu" ou tel que défini par ISO 8601 (par ex. P4DT1H15M20S ce qui est équivalent à 4 1:15:20), ou au format d’intervalle jour-heure de PostgreSQL (par ex. 3 days 04:05:06).

Changed in Django 2.0:

La prise en charge du format d’intervalle PostgreSQL a été ajoutée.

django.utils.decorators

method_decorator(decorator, name='')[source]

Convertit un décorateur de fonction en un décorateur de méthode. Cette fonction peut être utilisée pour décorer des méthodes ou des classes ; dans ce dernier cas, name est le nom de la méthode à décorer et est obligatoire.

decorator peut aussi être une liste ou un tuple de fonctions. Celles-ci sont décorées dans l’ordre inverse, ce qui fait que l’ordre d’appel est le même que celui dans lequel les fonctions apparaissent dans la liste.

Voir décoration des vues fondées sur les classes pour un exemple d’utilisation.

decorator_from_middleware(middleware_class)[source]

Renvoie un décorateur de vue à partir d’une classe d’intergiciel. Cela permet d’utiliser des fonctionnalités d’intergiciel pour certaines vues seulement. L’intergiciel est créé sans aucun paramètre.

Il s’attend à des intergiciels compatibles avec l’ancien style de Django jusqu’à 1.9 (en ayant des méthodes comme process_request(), process_exception() et process_response()).

decorator_from_middleware_with_args(middleware_class)[source]

Comme decorator_from_middleware, mais renvoie une fonction qui accepte des paramètres à transmettre à la classe middleware_class. Par exemple, le décorateur cache_page() est créé à partir de CacheMiddleware comme ceci :

cache_page = decorator_from_middleware_with_args(CacheMiddleware)

@cache_page(3600)
def my_view(request):
    pass

django.utils.encoding

python_2_unicode_compatible()[source]

Un décorateur qui définit les méthodes __unicode__ et __str__ avec Python 2. Avec Python 3, il ne fait rien.

Pour pouvoir prendre en charge à la fois Python 2 et 3 avec une seule base de code, définissez une méthode __str__ renvoyant du texte (en utilisant six.text_type() si du forçage de type doit avoir lieu) et appliquez ce décorateur à la classe.

smart_text(s, encoding='utf-8', strings_only=False, errors='strict')[source]

Renvoie un objet str représentant s. Traite les chaînes d’octets en utilisant le codage encoding.

Si strings_only est True, ne convertit pas certains objets non assimilables à des chaînes.

is_protected_type(obj)[source]

Détermine si l’instance d’objet est d’un type protégé.

Les objets d’un type protégé sont préservés tels quels lorsqu’ils sont transmis à force_text(strings_only=True).

force_text(s, encoding='utf-8', strings_only=False, errors='strict')[source]

Semblable à smart_text, sauf que les instances différées sont évaluées en chaînes, plutôt que de conserver leur état différé.

Si strings_only est True, ne convertit pas certains objets non assimilables à des chaînes.

smart_bytes(s, encoding='utf-8', strings_only=False, errors='strict')[source]

Renvoie une version de s sous forme de chaîne d’octets, en utilisant le codage indiqué dans encoding.

Si strings_only est True, ne convertit pas certains objets non assimilables à des chaînes.

force_bytes(s, encoding='utf-8', strings_only=False, errors='strict')[source]

Semblable à smart_bytes, sauf que les instances différées sont évaluées en chaînes d’octets, plutôt que de conserver leur état différé.

Si strings_only est True, ne convertit pas certains objets non assimilables à des chaînes.

smart_str(s, encoding='utf-8', strings_only=False, errors='strict')

Alias de smart_text(). Cette fonction renvoie un type str ou une chaîne différée.

Cela convient par exemple à l’écriture vers sys.stdout.

Alias de smart_bytes() avec Python 2 (dans les anciennes versions de Django qui prennent encore en charqe cette version).

force_str(s, encoding='utf-8', strings_only=False, errors='strict')

Alias de force_text(). Cette fonction renvoie toujours un objet str.

Alias de force_bytes() avec Python 2 (dans les anciennes versions de Django qui prennent encore en charqe cette version).

iri_to_uri(iri)[source]

Convertit une portion d’identifiant de ressource internationalisé (IRI) en portion d’URI qui convient pour l’inclusion dans une URL.

Il s’agit de l’algorithme de la section 3.1 de la RFC 3987#section-3.1, légèrement simplifiée dans la mesure où l’on admet que la valeur d’entrée est une chaîne et non pas un flux binaire arbitraire.

Accepte une IRI (chaîne ou octets UTF-8) et renvoie une chaîne contenant le résultat encodé.

uri_to_iri(uri)[source]

Convertit une URI (Uniform Resource Identifier) en une IRI (Internationalized Resource Identifier).

Il s’agit d’un algorithme inspiré de la section 3.2 de la RFC 3987#section-3.2.

Accepte une URI en octets ASCII et renvoie une chaîne contenant le résultat encodé.

filepath_to_uri(path)[source]

Convertit un chemin de système de fichiers en une portion d’URI convenable pour son inclusion dans une URL. Le chemin en entrée doit être soit des octets UTF-8, soit une chaîne.

Cette méthode code certains caractères qui sont normalement identifiés comme des caractères spéciaux dans les URI. Notez que cette méthode ne code pas le caractère « ” » car c’est un caractère accepté dans les URI. Voir la fonction JavaScript encodeURIComponent() pour plus de détails.

Renvoie une chaîne ASCII contenant le résultat encodé.

escape_uri_path(path)[source]

Échappe les caractères non sûrs de la portion de chemin d’un URI (Uniform Resource Identifier).

django.utils.feedgenerator

Exemple d’utilisation :

>>> from django.utils import feedgenerator
>>> feed = feedgenerator.Rss201rev2Feed(
...     title="Poynter E-Media Tidbits",
...     link="http://www.poynter.org/column.asp?id=31",
...     description="A group Weblog by the sharpest minds in online media/journalism/publishing.",
...     language="en",
... )
>>> feed.add_item(
...     title="Hello",
...     link="http://www.holovaty.com/test/",
...     description="Testing.",
... )
>>> with open('test.rss', 'w') as fp:
...     feed.write(fp, 'utf-8')

Pour simplifier la sélection d’un générateur, utilisez feedgenerator.DefaultFeed qui est actuellement Rss201rev2Feed.

Pour les définitions des différentes versions de RSS, voir https://web.archive.org/web/20110718035220/http://diveintomark.org/archives/2004/02/04/incompatible-rss

get_tag_uri(url, date)[source]

Crée un TagURI.

Voir https://web.archive.org/web/20110514113830/http://diveintomark.org/archives/2004/05/28/howto-atom-id

SyndicationFeed

class SyndicationFeed[source]

Classe de base pour tous les flux de syndication. Les sous-classes doivent implémenter write().

__init__(title, link, description, language=None, author_email=None, author_name=None, author_link=None, subtitle=None, categories=None, feed_url=None, feed_copyright=None, feed_guid=None, ttl=None, **kwargs)[source]

Initialise le flux avec le dictionnaire de métadonnées indiqué, qui s’applique au flux entier.

Tout paramètre nommé supplémentaire passé à __init__ est stocké dans self.feed.

Tous les paramètres doivent être des chaînes, à l’exception de categories, qui doit être une liste de chaînes.

add_item(title, link, description, author_email=None, author_name=None, author_link=None, pubdate=None, comments=None, unique_id=None, categories=(), item_copyright=None, ttl=None, updateddate=None, enclosures=None, **kwargs)[source]

Ajoute un élément au flux. Tous les paramètres sont censés être des chaînes, sauf pubdate et updateddate qui doivent être des objets datetime.datetime, et enclosures qui doit être une liste d’instances Enclosure.

num_items()[source]
root_attributes()[source]

Renvoie des attributs supplémentaires à ajouter à l’élément racine (c’est-à-dire le flux ou canal). Appelé depuis write().

add_root_elements(handler)[source]

Ajoute des éléments à l’élément racine (c’est-à-dire le flux ou canal). Appelé depuis write().

item_attributes(item)[source]

Renvoie des attributs supplémentaires à placer dans chaque élément du flux.

add_item_elements(handler, item)[source]

Ajoute des éléments pour chaque élément du flux.

write(outfile, encoding)[source]

Exporte le flux dans le codage indiqué vers outfile qui est un objet de type fichier. Les sous-classes sont censées surcharger cette méthode.

writeString(encoding)[source]

Renvoie le flux dans le codage indiqué sous forme de chaîne.

latest_post_date()[source]

Renvoie la dernière date pubdate ou updateddate parmi tous les éléments du flux. Si aucun de ces attributs n’est trouvé sur aucun élément, la date/heure UTC actuelle est renvoyée.

Changed in Django 1.11:

Dans les versions précédentes, il renvoyait la date/heure courante sans aucune information de fuseau horaire.

Enclosure

class Enclosure[source]

Représente une annexe RSS.

RssFeed

class RssFeed(SyndicationFeed)[source]

Rss201rev2Feed

class Rss201rev2Feed(RssFeed)[source]

Spécification : https://cyber.harvard.edu/rss/rss.html

RssUserland091Feed

class RssUserland091Feed(RssFeed)[source]

Spécification : http://backend.userland.com/rss091

Atom1Feed

class Atom1Feed(SyndicationFeed)[source]

Spécification : https://tools.ietf.org/html/rfc4287

django.utils.functional

class cached_property(object, name)[source]

Le décorateur @cached_property met en cache le résultat d’une méthode ayant un seul paramètre self sous forme de propriété. Le résultat en cache persiste aussi longtemps que l’instance, ce qui fait que si l’instance est conservée et que la fonction est appelée une nouvelle fois plus tard, le résultat en cache est renvoyé.

Considérons un cas typique où une vue a besoin d’appeler la méthode d’un modèle pour effectuer un certain calcul avant de placer cette instance de modèle dans le contexte passé au gabarit, et celui-ci a aussi besoin d’appeler la méthode une nouvelle fois :

# the model
class Person(models.Model):

    def friends(self):
        # expensive computation
        ...
        return friends

# in the view:
if person.friends():
    ...

Et dans le gabarit, vous auriez :

{% for friend in person.friends %}

friends() sera ici appelée deux fois. Puisque les instances person dans la vue et dans le gabarit représentent la même instance, décorer la méthode friends() avec @cached_property permet d’éviter cela

from django.utils.functional import cached_property

class Person(models.Model):

    @cached_property
    def friends(self):
        ...

Notez que la méthode étant maintenant devenue une propriété, le code Python doit l’invoquer de manière adéquate :

# in the view:
if person.friends:
    ...

La valeur en cache peut être traitée comme n’importe quel autre attribut normal de l’instance :

# clear it, requiring re-computation next time it's called
del person.friends # or delattr(person, "friends")

# set a value manually, that will persist on the instance until cleared
person.friends = ["Huckleberry Finn", "Tom Sawyer"]

En plus d’offrir des avantages potentiels en terme de performance, @cached_property peut garantir que la valeur d’un attribut ne change pas de manière inattendue au cours de la vie d’une instance. Cela pourrait se produire avec une méthode dont le calcul est basé sur datetime.now(), ou simplement dans le cas où la base de données est modifiée par une autre processus dans le bref intervalle entre des appels successifs d’une méthode de la même instance.

Vous pouvez utiliser le paramètre name pour créer des propriétés en cache pour d’autres méthodes. Par exemple, si vous avez une méthode coûteuse get_friends() et que vous vouliez permettre de l’appeler aussi sans récupérer la valeur en cache, vous pourriez écrire :

friends = cached_property(get_friends, name='friends')

Alors que person.get_friends() recalcule les amis à chaque appel, la valeur de la propriété en cache persiste tant que vous ne la supprimez pas, comme expliqué ci-dessus :

x = person.friends         # calls first time
y = person.get_friends()   # calls again
z = person.friends         # does not call
x is z                     # is True
keep_lazy(func, *resultclasses)[source]

Django offre de nombreuses fonctions utilitaires (particulièrement dans django.utils) qui acceptent une chaîne comme premier paramètre et font quelque chose avec cette chaîne. Ces fonctions sont utilisées aussi bien par des filtres de gabarit que de façon directe dans du code Python.

Si vous écrivez vous-même des fonctions semblables et que vous devez gérer des traductions, vous serez confronté au problème du traitement du premier paramètre quand il s’agit d’un objet de traduction différée. Il n’est pas souhaitable de le convertir immédiatement en chaîne de caractères, car il se peut que cette fonction soit utilisée en dehors d’une vue (et donc que le réglage de langue du fil d’exécution en cours ne soit pas le bon).

Pour des cas comme celui-là, utilisez le décorateur django.utils.functional.keep_lazy(). Il modifie la fonction afin que si elle est appelée avec en paramètre une traduction différée, l’évaluation de la fonction est reportée jusqu’au moment où il devient vraiment nécessaire de produire une chaîne.

Par exemple :

from django.utils.functional import keep_lazy, keep_lazy_text

def fancy_utility_function(s, ...):
    # Do some conversion on string 's'
    ...
fancy_utility_function = keep_lazy(str)(fancy_utility_function)

# Or more succinctly:
@keep_lazy(str)
def fancy_utility_function(s, ...):
    ...

Le décorateur keep_lazy() accepte quelques paramètres supplémentaires (*args) indiquant le ou les types renvoyés par la fonction originale. Un cas d’utilisation fréquent est d’avoir des fonctions qui renvoient du texte. Pour celles-ci, il suffit de passer le type str à keep_lazy (ou même plus simplement, utilisez le décorateur keep_lazy_text() présenté à la section suivante).

L’emploi de ce décorateur permet d’écrire une fonction et de compter sur la présence d’une vraie chaîne en entrée, puis d’ajouter au final la prise en charge des objets de traduction différée.

keep_lazy_text(func)[source]

Un raccourci pour keep_lazy(str)(func).

Si vous avez une fonction qui renvoie du texte et que vous souhaitez pouvoir accepter des paramètres dont l’évaluation est différée, utilisez simplement ce décorateur :

from django.utils.functional import keep_lazy, keep_lazy_text

# Our previous example was:
@keep_lazy(str)
def fancy_utility_function(s, ...):
    ...

# Which can be rewritten as:
@keep_lazy_text
def fancy_utility_function(s, ...):
    ...

django.utils.html

En principe, le code HTML doit être construit avec des gabarits Django pour profiter de leur mécanisme d’échappement automatique, en faisant appel aux utilitaires de django.utils.safestring en cas de besoin. Ce module fournit quelques utilitaires supplémentaires de bas niveau pour l’échappement de code HTML.

escape(text)[source]

Renvoie le texte donné en codant les esperluettes, les guillemets et les chevrons de manière adaptée au HTML. Le texte en entrée est d’abord passé dans la fonction force_text() et le résultat final est marqué comme sûr avec mark_safe().

conditional_escape(text)[source]

Semblable à escape(), sauf qu’elle n’opère pas sur les chaînes déjà échappées afin d’éviter un double échappement.

format_html(format_string, *args, **kwargs)[source]

Cette fonction ressemble à str.format(), sauf qu’elle est particulièrement appropriée pour la construction de fragments HTML. Tous les paramètres (args/kwargs) passent par conditional_escape() avant d’être transmis à str.format().

Dans les cas où il s’agit de produire des petits fragments HTML, cette fonction doit être préférée à l’interpolation de chaîne directe avec % ou str.format(), car elle applique l’échappement à tous ses paramètres, tout comme le fait le système de gabarit par défaut.

Donc au lieu d’écrire :

mark_safe("%s <b>%s</b> %s" % (
    some_html,
    escape(some_text),
    escape(some_other_text),
))

Il est préférable d’écrire :

format_html("{} <b>{}</b> {}",
    mark_safe(some_html),
    some_text,
    some_other_text,
)

Ceci présente l’avantage de ne pas devoir appliquer soi-même escape() à chacun des paramètres et de risquer une anomalie ou une vulnérabilité XSS si on en oublie un.

Notez que bien que cette fonction utilise str.format() pour effectuer l’interpolation, certaines des options de format fournies par str.format() (par ex. les formats de nombre) ne fonctionnent pas, car tous les paramètres sont passés par la moulinette conditional_escape() qui appelle force_text() sur les valeurs reçues.

format_html_join(sep, format_string, args_generator)[source]

Une adaptateur de format_html() conçu pour le cas courant d’un groupe de paramètres devant être mis en forme avec la même chaîne de format, puis combinés avec sep. sep passe lui-même aussi par conditional_escape().

args_generator doit être un itérateur renvoyant la liste de paramètres args qui seront transmis à format_html(). Par exemple :

format_html_join(
    '\n', "<li>{} {}</li>",
    ((u.first_name, u.last_name) for u in users)
)
strip_tags(value)[source]

Tente de supprimer de la chaîne tout ce qui ressemble à une balise HTML, c’est-à-dire tout ce qui est contenu à l’intérieur de <>.

Il n’y a absolument AUCUNE garantie que la chaîne résultante sera vraiment sûre du point de vue HTML. Il ne faut donc JAMAIS marquer comme sûre le résultat d’un appel à strip_tag sans l’avoir d’abord échappé, par exemple avec escape().

Par exemple :

strip_tags(value)

Si value vaut "<b>Joël</b> <button>est</button> une <span>limace</span>", la valeur renvoyée sera "Joël est une limace".

If you are looking for a more robust solution, take a look at the bleach Python library.

html_safe()[source]

La méthode __html__() d’une classe aide les gabarits non Django à détecter les classes dont le résultat ne demande pas d’échappement HTML.

Ce décorateur définit la méthode __html__() pour la classe décorée en enveloppant __str__() dans mark_safe(). Assurez-vous que la méthode __str__() renvoie effectivement du texte qui ne demande pas d’échappement HTML.

django.utils.http

urlencode(query, doseq=False)[source]

Une version de la fonction Python urllib.parse.urlencode() pouvant agir sur des dictionnaires MultiValueDict et d’autres valeurs qui ne sont pas des chaînes.

cookie_date(epoch_seconds=None)[source]

Met en forme la date pour garantir la compatibilité avec le standard de cookie Netscape.

Accepte un nombre à virgule exprimé en secondes depuis le temps Unix initial en UTC, de manière semblable à ce que produit time.time(). Si le paramètre est None, c’est la date actuelle qui est renvoyée.

Produit une chaîne au format Wdy, DD-Mon-YYYY HH:MM:SS GMT.

http_date(epoch_seconds=None)[source]

Met en forme la date/heure en respectant le format de date RFC 1123 tel que défini par la RFC 7231#section-7.1.1.1 du standard HTTP.

Accepte un nombre à virgule exprimé en secondes depuis le temps Unix initial en UTC, de manière semblable à ce que produit time.time(). Si le paramètre est None, c’est la date actuelle qui est renvoyée.

Produit une chaîne au format Wdy, DD Mon YYYY HH:MM:SS GMT.

base36_to_int(s)[source]

Convertit une chaîne base 36 en nombre entier.

int_to_base36(i)[source]

Convertit un nombre entier positif en chaîne base 36.

urlsafe_base64_encode(s)[source]

Code une chaîne d’octets en base64 pour être utilisée dans les URL, en enlevant d’éventuels signes « égal » finaux.

urlsafe_base64_decode(s)[source]

Décode une chaîne codée en base64, ajoutant d’éventuels signes « égal » finaux qui pourraient avoir été enlevés.

django.utils.module_loading

Fonctions pour manipuler les modules Python.

import_string(dotted_path)[source]

Importe un chemin pointé de module et renvoie la classe ou l’attribut désigné par le dernier nom du chemin. Génère ImportError si l’importation échoue. Par exemple :

from django.utils.module_loading import import_string
ValidationError = import_string('django.core.exceptions.ValidationError')

est équivalent à :

from django.core.exceptions import ValidationError

django.utils.safestring

Fonctions et classes pour travailler avec des « chaînes sûres » : des chaînes qui peuvent être affichées sans crainte sans devoir subir d’échappement HTML. Quand une chaîne est marquée comme « sûre » (safe), cela signifie que le producteur de la chaîne a déjà transformé en entités appropriées les caractères qui ne doivent pas être interprétés par le moteur HTML (par ex. « < »).

class SafeString

Une sous-classe de str pour des chaînes ayant été explicitement marquées comme « sûres » (plus besoin d’échappement) à des fins d’affichage HTML. Alias de SafeText.

class SafeText[source]

Une sous-classe de str pour des chaînes ayant été explicitement marquées comme « sûres » à des fins d’affichage HTML.

mark_safe(s)[source]

Marque explicitement une chaîne comme sûre en vue de son affichage (HTML). L’objet renvoyé peut être utilisé partout où une chaîne peut être utilisé.

Cette fonction peut être utilisée plusieurs fois sur la même chaîne.

Peut aussi être utilisé comme décorateur.

Pour la construction de fragments de HTML, il est généralement préférable d’utiliser plutôt django.utils.html.format_html().

Une chaîne marquée comme sûre redevient non sûre quand elle est modifiée. Par exemple :

>>> mystr = '<b>Hello World</b>   '
>>> mystr = mark_safe(mystr)
>>> type(mystr)
<class 'django.utils.safestring.SafeText'>

>>> mystr = mystr.strip()  # removing whitespace
>>> type(mystr)
<type 'str'>
Changed in Django 1.11:

La possibilité d’utilisation comme décorateur a été ajoutée.

django.utils.text

format_lazy(format_string, *args, **kwargs)
New in Django 1.11.

Une version de str.format() pour les cas où format_string, args ou kwargs contiennent des objets différés. Le premier paramètre est la chaîne à mettre en forme. Par exemple :

from django.utils.text import format_lazy
from django.utils.translation import pgettext_lazy

urlpatterns = [
    path(format_lazy('{person}/<int:pk>/', person=pgettext_lazy('URL', 'person')),
         PersonDetailView.as_view()),
]

Cet exemple permet aux traducteurs de traduire une partie de l’URL. Si « person » est traduit en « persona », l’expression régulière va correspondre à persona/(?P<pk>\d+)/$, par ex. persona/5/.

slugify(allow_unicode=False)[source]

Convertit en ASCII si allow_unicode vaut False (par défaut). Convertit les espaces en tirets. Enlève les caractères qui ne sont ni alphanumériques, ni soulignements, ni tirets. Convertit en minuscules. Les espaces en début et fin de chaîne sont aussi enlevés.

Par exemple :

slugify(value)

Si value contient "Joël est une limace", le résultat sera joel-est-une-limace.

Vous pouvez définir le paramètre allow_unicode à True, si vous souhaitez permettre les caractères Unicode :

slugify(value, allow_unicode=True)

Si value contient "你好 World", le résultat sera "你好-world".

django.utils.timezone

utc

Instance tzinfo qui représente le temps UTC.

class FixedOffset(offset=None, name=None)[source]

Une sous-classe de tzinfo simulant un décalage fixe par rapport au temps UTC. offset est un nombre entier de minutes à l’est d’UTC.

get_fixed_timezone(offset)[source]

Renvoie une instance tzinfo représentant un fuseau horaire avec un décalage UTC fixe.

offset est une différence de temps datetime.timedelta ou un nombre entier en minutes. Utilisez des valeurs positives pour les fuseaux horaires à l’est d’UTC et des valeurs négatives à l’ouest d’UTC.

get_default_timezone()[source]

Renvoie une instance tzinfo qui représente le fuseau horaire par défaut.

get_default_timezone_name()[source]

Renvoie le nom du fuseau horaire par défaut.

get_current_timezone()[source]

Renvoie une instance tzinfo qui représente le fuseau horaire en cours.

get_current_timezone_name()[source]

Renvoie le nom du fuseau horaire en cours.

activate(timezone)[source]

Définit le fuseau horaire actif. Le paramètre timezone doit être une instance d’une sous-classe de tzinfo ou un nom de fuseau horaire.

deactivate()[source]

Désactive le fuseau horaire actuel.

override(timezone)[source]

Gestionnaire de contexte Python qui définit le fuseau horaire actif lorsqu’il entre en action avec activate(), puis restaure le fuseau horaire précédemment actif en quittant. Si le paramètre timezone vaut None, le fuseau horaire actif est alors désactivé à l’entrée du gestionnaire avec deactivate().

override est aussi utilisable comme décorateur de fonction.

localtime(value=None, timezone=None)[source]

Convertit un objet datetime conscient vers un fuseau horaire différent, par défaut le fuseau horaire actif.

Lorsque value est omise, la valeur par défaut est now().

Cette fonction ne fonctionne pas avec des objets date/heure naïfs ; utilisez alors plutôt make_aware().

Changed in Django 1.11:

Dans les versions précédentes, value était un paramètre obligatoire.

localdate(value=None, timezone=None)[source]
New in Django 1.11.

Utilise localtime() pour convertir un objet datetime conscient en une date() dans un fuseau horaire différent, par défaut le fuseau horaire actif.

Lorsque value est omise, la valeur par défaut est now().

Cette fonction ne fonctionne pas avec des objets date/heure naïfs.

now()[source]

Renvoie un objet datetime représentant le moment actuel dans le temps (« maintenant »). La valeur précisément renvoyée dépend de la valeur de USE_TZ:

  • Si USE_TZ est False, il s’agira d’une date/heure naïve (c’est-à-dire une date/heure sans fuseau horaire associé) représentant le temps actuel dans le fuseau horaire local du système.
  • Si USE_TZ est True, il s’agira d’une date/heure consciente représentant le temps actuel en UTC. Notez que now() renvoie toujours le temps UTC quelle que soit la valeur de TIME_ZONE; vous pouvez utiliser localtime() pour obtenir l’heure dans le fuseau horaire actif.
is_aware(value)[source]

Renvoie True si value est consciente, False si elle est naïve. Cette fonction présuppose que value est un objet datetime.

is_naive(value)[source]

Renvoie True si value est naïve, False si elle est consciente. Cette fonction présuppose que value est un objet datetime.

make_aware(value, timezone=None, is_dst=None)[source]

Renvoie un objet datetime conscient représentant le même moment dans le temps que value dans le fuseau timezone, value étant un objet datetime naïf. Si timezone est défini à None, il prend le fuseau horaire actuel comme valeur par défaut.

L’exception pytz.AmbiguousTimeError est générée quand on essaie de rendre value consciente pendant une transition d’heure d’été/hiver et quand la même heure survient deux fois (passage heure d’été à hiver). En définissant is_dst à True ou False, l’exception est évitée en choisissant si l’heure est celle qui précède ou celle qui suit la transition, respectivement.

L’exception pytz.NonExistentTimeError est générée quand on essaie de rendre value consciente pendant une transition d’heure d’été/hiver et quand l’heure concernée ne survient jamais (passage heure d’hiver à été). En définissant is_dst à True ou False, l’exception est évitée en décalant l’heure de 1 heure en arrière ou en avant, respectivement. Par exemple, is_dst=True change une heure impossible de 2:30 à 1:30 et is_dst=False change la même heure à 3:30.

make_naive(value, timezone=None)[source]

Renvoie un objet datetime naïf représentant le même moment dans le temps que value dans le fuseau timezone, value étant un objet datetime conscient. Si timezone est défini à None, il prend le fuseau horaire actuel comme valeur par défaut.

django.utils.translation

Pour une discussion complète sur l’utilisation de ce qui suit, consultez la documentation sur la traduction.

Le préfixe u des fonctions ci-dessous vient d’une différence en Python 2 entre les chaînes Unicode et chaînes d’octets. Si votre code ne prend plus en charge Python 2, utilisez les fonctions sans le u.

gettext(message)[source]
ugettext(message)

Traduit message et renvoie le résultat dans une chaîne.

pgettext(context, message)[source]

Traduit message selon context et renvoie le résultat dans une chaîne.

Pour plus d’informations, voir Marqueurs contextuels.

gettext_lazy(message)
ugettext_lazy(message)
pgettext_lazy(context, message)

Même comportement que les versions non différées ci-dessus, mais en utilisant une exécution différée.

Voir la documentation sur les traductions différées.

gettext_noop(message)[source]
ugettext_noop(message)

Marque les chaînes en vue de leur traduction mais ne les traduit pas sur le moment. Cela peut être utile pour stocker des chaînes qui doivent rester dans la langue de base (parce qu’elles pourraient être utilisées de manière externe) dans des variables globales et que ces chaînes seront traduites plus tard.

ngettext(singular, plural, number)[source]
ungettext(singular, plural, number)

Traduit singular et plural et renvoie la chaîne appropriée en fonction de number.

npgettext(context, singular, plural, number)[source]

Traduit singulier et pluriel et renvoie la chaîne appropriée en fonction de nombre et de context.

ngettext_lazy(singular, plural, number)[source]
ungettext_lazy(singular, plural, number)
npgettext_lazy(context, singular, plural, number)[source]

Même comportement que les versions non différées ci-dessus, mais en utilisant une exécution différée.

Voir la documentation sur les traductions différées.

string_concat(*strings)

Obsolète depuis la version 1.11: Préférez django.utils.text.format_lazy(). string_concat(*strings) peut être remplacé par format_lazy('{}' * len(strings), *strings).

Variante différée de la concaténation de chaînes, nécessaire pour les traductions qui sont formées de plusieurs parties.

activate(language)[source]

Récupère le catalogue de traduction d’une langue donnée et l’active comme catalogue de traduction courant pour le fil d’exécution en cours.

deactivate()[source]

Désactive le catalogue de traduction actif afin que des appels à _ subséquents vont refaire appel au catalogue de traduction par défaut.

deactivate_all()[source]

Place une instance de NullTranslations() comme catalogue de traduction actif. Cela peut être utile si l’on souhaite que des traductions différées apparaissent avec leur chaîne originale (donc non traduite) pour une raison quelconque.

override(language, deactivate=False)[source]

Un gestionnaire de contexte Python qui utilise django.utils.translation.activate() pour récupérer le catalogue de traduction d’une langue données, qui l’active comme catalogue de traduction pour le fil d’exécution en cours et qui réactive la langue précédemment active lors de sa sortie. Il est possible de définir le paramètre deactivate à True si l’on souhaite que la langue de traduction temporaire soit simplement désactivée à la sortie du gestionnaire avec django.utils.translation.deactivate(). Si le paramètre language vaut None, une instance de NullTranslations() est activée dans le code affecté par le gestionnaire de contexte.

override est aussi utilisable comme décorateur de fonction.

check_for_language(lang_code)[source]

Contrôle s’il existe un fichier de langue global pour le code de langue donné (par ex. “fr”, “pt_BR”). Ceci est utilisé pour décider si une langue demandée par un utilisateur est disponible.

get_language()[source]

Renvoie le code de langue actuellement sélectionné. Renvoie None si les traductions sont temporairement désactivées (par deactivate_all() ou lorsque None est passé à override()).

get_language_bidi()[source]

Renvoie l’agencement bidirectionnel de la langue sélectionnée :

  • False = agencement de gauche à droite
  • True = agencement de droite à gauche
get_language_from_request(request, check_path=False)[source]

Analyse la requête pour trouver quelle est la langue souhaitée par l’utilisateur. Seules les langues figurant dans settings.LANGUAGES sont prises en compte. Si l’utilisateur demande un sous-code de langue alors que seule la langue principale est disponible, c’est la langue principale qui est renvoyée.

Si check_path vaut True, la fonction examine d’abord l’URL demandée pour voir si son chemin commence par un code de langue figurant dans le réglage LANGUAGES.

to_locale(language)[source]

Transforme un nom de langue (en-us) en un nom de locale (en_US).

templatize(src)[source]

Transforme un gabarit Django en un contenu analysable par xgettext. Ce processus traduit les balises de traduction de Django en invocations de fonctions gettext standard.

LANGUAGE_SESSION_KEY

Clé de session servant à stocker la langue active de la session en cours.

Back to Top