# Documentation Django 5.2.8

# L’objet `File`

Le module `django.core.files` et ses sous-modules contiennent les classes intégrées pour la gestion de base des fichiers dans Django.

## La classe `File`

class File(file_object, name=None)

  The `File` class is a thin wrapper around a Python file object with some Django-specific additions. Internally, Django uses this class when it needs to represent a file.

  Les objets `File` possèdent les attributs et méthodes suivants :

  name

    Le nom du fichier, comprenant le chemin relatif du réglage `MEDIA_ROOT`.

  size

    La taille du fichier en octets.

  file

    The underlying file object that this class wraps.

    Soyez prudent avec cet attribut dans les sous-classes.

    Some subclasses of `File`, including `ContentFile` and `FieldFile`, may replace this attribute with an object other than a Python file object. In these cases, this attribute may itself be a `File` subclass (and not necessarily the same subclass). Whenever possible, use the attributes and methods of the subclass itself rather than the those of the subclass’s `file` attribute.

  mode

    Le mode lecture/écriture du fichier.

  open(mode=None, *args, **kwargs)

    Open or reopen the file (which also does `File.seek(0)`). The `mode` argument allows the same values as Python’s built-in `open()`. `*args` and `**kwargs` are passed after `mode` to Python’s built-in `open()`.

    Lors de la réouverture d’un fichier, `mode` écrase le mode avec lequel le fichier a été initialement ouvert ; `None` signifie que le mode initial doit être utilisé pour la réouverture.

    Vous pouvez l’utiliser comme un gestionnaire de contexte, par ex. `with file.open() as f:`.

  __iter__()

    Lit le fichier par itération en renvoyant les lignes une à une.

  chunks(chunk_size=None)

    Lit le fichier par itération en renvoyant des blocs (« chunks »)de la taille indiquée. La valeur par défaut de `chunk_size` est 64 Ko.

    C’est particulièrement utile pour les gros fichiers car cela permet de les lire en flux à partir du disque en évitant de stocker la totalité du fichier en mémoire.

  multiple_chunks(chunk_size=None)

    Renvoie `True` si la taille du fichier nécessite de le partitionner en plusieurs blocs pour le lire en entier, en fonction de la taille `chunk_size`.

  close()

    Ferme le fichier.

  En plus des méthodes mentionnées, `File` expose les attributs et méthodes suivants de son objet `file`: `encoding`, `fileno`, `flush`, `isatty`, `newlines`, `read`, `readinto`, `readline`, `readlines`, `seek`, `tell`, `truncate`, `write`, `writelines`, `readable()`, `writable()` et `seekable()`.

## La classe `ContentFile`

class ContentFile(content, name=None)

  La classe `ContentFile` hérite de `File`, mais contrairement à celle-ci, elle n’agit que sur du contenu de type chaîne (octets aussi admis), plutôt que sur un vrai fichier. Par exemple :

      from django.core.files.base import ContentFile

      f1 = ContentFile("esta frase está en español")
      f2 = ContentFile(b"these are bytes")

## La classe `ImageFile`

class ImageFile(file_object, name=None)

  Django fournit une classe intégrée tout exprès pour les images. `django.core.files.images.ImageFile` hérite de tous les attributs et méthodes de `File`, et offre en plus les éléments suivants :

  width

    Largeur de l’image en pixels.

  height

    Hauteur de l’image en pixels.

## Méthodes supplémentaires pour les fichiers liés à des objets

Tout fichier `File` associé à un objet (comme pour `Car.photo` ci-dessous) possède également quelque méthodes supplémentaires :

File.save(name, content, save=True)

  Enregistre un nouveau fichier avec le nom de fichier et le contenu indiqués. Cela ne remplacera pas le fichier existant, mais un nouveau fichier sera créé et l’objet sera mis à jour pour pointer vers ce fichier. Si `save` vaut `True`, la méthode `save()` du modèle sera appelée après l’enregistrement du fichier. C’est-à-dire que ces deux lignes :

      >>> car.photo.save("myphoto.jpg", content, save=False)
      >>> car.save()

  sont équivalentes à :

      >>> car.photo.save("myphoto.jpg", content, save=True)

  Notez que le paramètre `content` doit être soit une instance de `File` , soit une sous-classe de `File`, comme par exemple `ContentFile`.

File.delete(save=True)

  Enlève le fichier de l’instance de modèle et supprime le fichier concerné. Si `save` vaut `True`, la méthode `save()` du modèle sera appelée après la suppression du fichier.