4.7.1.2 Objets StreamWriter

La classe StreamWriter est une sous-classe de Codec et définit les méthodes suivantes que chaque générateur de flux doit définir afin d'être compatible au registre Python des codecs.

StreamWriter(stream[, errors])

Constructeur d'une instance de StreamWriter.

Tous les générateurs de flux doivent fournir cette interface de constructeur. Ils sont libres d'ajouter des mot-clés d'arguments additionnels, mais seuls ceux définis ici sont employés par le registre de codecs Python.

stream doit être un objet fichier (ou similaire) ouvert pour l'écriture de données (binaires).

StreamWriter peut implémenter différents schémas de gestion des erreurs en fournissant l'argument mot-clé errors. Ces paramètres sont définis:

'strict' Lève ValueError (ou une sous-classe); c'est la valeur par défaut.
'ignore' Ignore le caractère et continue avec le prochain.
'replace' Remplace par un caractère approprié de substitut

write(object)

Écrit le contenu de l'objet encodé dans le flux.

writelines(list)

Écrit la liste concaténée de chaines dans le flux (probablement en réutilisant la méthode write()).

reset()

Vide et remet à zéro les tampons des codecs utilisés pour garder l'état.

Appeler cette méthode devrait assurer que les données sur la sortie sont mises dans un état propre, cela permet d'ajouter de nouvelles données fraîches sans devoir parcourrir le flux entier pour récupérer l'état.

En plus des méthodes ci-dessus, StreamWriter doit également hériter de toutes les autres méthodes et attributs du flux.