- en
- Langue : fr
API de stockage des fichiers¶
Accès à la classe de stockage en cours¶
Django offre deux manières pratiques d’accéder à la classe de stockage active :
- class DefaultStorage[source]¶
DefaultStorage offre un accès différé au système de stockage par défaut en cours tel que défini par DEFAULT_FILE_STORAGE. DefaultStorage utilise get_storage_class() en interne.
- get_storage_class(import_path=None)[source]¶
Renvoie une classe ou un module qui implémente l’API de stockage.
Lorsqu’on l’appelle sans le paramètre import_path, get_storage_class renvoie le système de stockage par défaut en cours tel que défini par DEFAULT_FILE_STORAGE. Si import_path est fourni, get_storage_class essaie d’importer la classe ou le module désigné par le chemin donné et le renvoie en cas de succès. Une exception est générée si l’importation échoue.
La classe FileSystemStorage¶
- class FileSystemStorage(location=None, base_url=None, file_permissions_mode=None, directory_permissions_mode=None)[source]¶
La classe FileSystemStorage implémente le stockage de fichiers de base sur un système de fichiers local. Elle hérite de Storage et offre des implémentations pour toutes les méthodes publiques de celle-ci.
- location¶
Chemin absolu vers le répertoire qui contiendra les fichiers. La valeur par défaut est la valeur du réglage MEDIA_ROOT.
- base_url¶
URL de base pour servir les fichiers stockés à cet emplacement. La valeur par défaut est la valeur du réglage MEDIA_URL.
- file_permissions_mode¶
Les permissions de système de fichiers que le fichier reçoit quand il est enregistré. La valeur par défaut correspond à FILE_UPLOAD_PERMISSIONS.
New in Django 1.7:L’attribut file_permissions_mode a été ajouté. Précédemment, les fichiers recevaient toujours les permissions FILE_UPLOAD_PERMISSIONS.
- directory_permissions_mode¶
Les permissions de système de fichiers que le répertoire reçoit quand il est enregistré. La valeur par défaut correspond à FILE_UPLOAD_DIRECTORY_PERMISSIONS.
New in Django 1.7:L’attribut directory_permissions_mode a été ajouté. Précédemment, les répertoires recevaient toujours les permissions FILE_UPLOAD_DIRECTORY_PERMISSIONS.
Note
La méthode FileSystemStorage.delete() ne renvoie pas d’exception si le nom de fichier fourni en paramètre n’existe pas.
La classe Storage¶
- class Storage[source]¶
La classe Storage fournit une API standardisée pour le stockage de fichiers, accompagnée d’un ensemble de comportements par défaut que tous les autres systèmes de stockage peuvent hériter ou surcharger en cas de besoin.
Note
Pour les méthodes qui renvoient des objets datetime naïfs, le fuseau horaire réellement utilisé correspond à la valeur actuelle de os.environ['TZ']. Notez que cette valeur est généralement définie à partir du réglage TIME_ZONE de Django.
- accessed_time(name)[source]¶
Renvoie une objet datetime naïf contenant la date du dernier accès au fichier. Pour les systèmes de stockage qui ne peuvent pas renvoyer la date du dernier accès, cette méthode génère l’exception NotImplementedError.
- created_time(name)[source]¶
Renvoie un objet datetime naïf contenant la date de création du fichier. Pour les systèmes de stockage qui ne peuvent pas renvoyer la date de création, cette méthode génère l’exception NotImplementedError.
- delete(name)[source]¶
Supprime le fichier désigné par name. Si la suppression n’est pas prise en charge par le système de stockage cible, une exception NotImplementedError est générée.
- exists(name)[source]¶
Renvoie True si le fichier désigné par le nom indiqué existe déjà dans le système de stockage, ou False si le nom est disponible pour un nouveau fichier.
- get_available_name(name, max_length=None)[source]¶
Renvoie un nom de fichier sur la base du paramètre name et qui est disponible pour recevoir un nouveau contenu à écrire sur le système de stockage cible.
La longueur du nom de fichier ne dépassera pas max_length, si cette option est indiquée. Si un nom de fichier unique n’est pas disponible, une exception SuspiciousFileOperation est générée.
Si un fichier avec nom existe déjà, un soulignement suivi d’une chaîne aléatoire de 7 caractères alphanumériques sont ajoutés à la fin du nom du fichier avant l’extension.
Changed in Django 1.7:Précédemment, un underscore et un numbre (par exemple "_1", "_2", etc.) étaient ajoutés à la fin du nom de fichier jusqu’à ce qu’un nom soit disponible dans le répertoire de destination. Un utilisateur malveillant pouvait exploiter cet algorithme déterministe pour mener à bien une attaque de type denial-of-service. Cette modification a également été effectuée dans les versions 1.6.6, 1.5.9 et 1.4.14 de Django.
Changed in Django 1.8:Le paramètre max_length a été ajouté.
- get_valid_name(name)[source]¶
Renvoie un nom de fichier sur la base du paramètre name et qui est adapté aux usages du système de stockage cible.
- listdir(path)[source]¶
Énumère le contenu du chemin indiqué, renvoyant un tuple de deux listes ; la première est une liste de répertoires, la seconde contient les fichiers. Pour les systèmes de stockage qui ne peuvent pas fournir une telle liste, une exception NotImplementedError est générée.
- modified_time(name)[source]¶
Renvoie un objet datetime naïf contenant la date de la dernière modification du fichier. Pour les systèmes de stockage qui ne peuvent pas renvoyer la date de dernière modification, cette méthode génère l’exception NotImplementedError.
- open(name, mode='rb')[source]¶
Ouvre le fichier désigné par name. Notez que bien que le fichier renvoyé soit garanti être un objet File, il se peut qu’il s’agisse d’une sous-classe. Dans le cas de systèmes de stockage distants, cela signifie que la lecture et l’écriture peuvent être lentes, il faut le savoir.
- path(name)[source]¶
Le chemin du système de fichiers local où le fichier peut être ouvert en utilisant l’appel Python standard open(). Pour les systèmes de stockage qui ne sont pas accessibles à partir du système de fichiers local, cette méthode génère une exception NotImplementedError.
- save(name, content, max_length=None)[source]¶
Enregistre un nouveau fichier en utilisant le système de stockage, de préférence avec le nom indiqué. Si le nom name est déjà utilisé pour un autre fichier, le système de stockage peut modifier le nom de fichier afin d’obtenir un nom unique si nécessaire. Le nom réellement utilisé pour stocker le fichier est renvoyé.
Le paramètre max_length est transmis plus loin à get_available_name().
Le paramètre content doit être une instance de django.core.files.File ou d’une sous-classe de django.core.files.File.
Changed in Django 1.8:Le paramètre max_length a été ajouté.
