Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / Python

Escrever, ler e obter texto com io.StringIO

Usa `write()` para escrever texto em memória por partes, `read()` para ler a partir da posição atual e `getvalue()` para obter todo o conteúdo do buffer sem voltar ao início.

Versão: Python 3.12

Sintaxe

Python 3.12 — method signatures for a stream created with io.StringIO(...):
stream.write(s, /) -> int
stream.read(size=-1, /) -> str
stream.getvalue() -> str

io.StringIO é um fluxo de texto em memória, não um ficheiro em disco. Um fluxo criado com io.StringIO(texto) começa na posição inicial, pelo que escrever de imediato pode sobrescrever o texto inicial. Para acrescentar texto no fim, chama primeiro stream.seek(0, io.SEEK_END).

stream.write(s) escreve um str na posição atual, faz avançar essa posição e devolve o número de caracteres escritos, não o número de bytes nem o texto. Passar bytes provoca TypeError; para dados binários em memória, usa io.BytesIO. write() não acrescenta uma quebra de linha. A opção predefinida newline='\n' não converte as quebras de linha na escrita. Numa assinatura, / indica que os parâmetros anteriores só podem ser passados por posição.

stream.read(n) devolve até n caracteres como str a partir da posição atual e avança para depois dos caracteres lidos. Sem indicar o tamanho, com None ou com um tamanho negativo, read() lê até ao fim; quando já está no fim, devolve ''. Usa stream.seek(0) para ler a partir do início.

stream.getvalue() devolve todo o buffer como str sem alterar a posição. Obtém o resultado antes de chamar close() ou de sair do bloco with: o fecho descarta o buffer e impede a utilização posterior destes métodos, mas uma cadeia de caracteres que já tenhas obtido continua disponível.

Exemplos

import io

with io.StringIO("red blue") as source, io.StringIO() as target:
    first = target.write(source.read(3).upper())
    second = target.write(source.read().upper())
    result = target.getvalue()
    print(first, second)
    print(repr(target.read()))

print(result)

Resultado

3 5
''
RED BLUE

As leituras consomem primeiro `red` e depois ` blue`. As duas escritas guardam os fragmentos em maiúsculas e devolvem `3` e `5`; o segundo fragmento inclui um espaço. `getvalue()` obtém todo o `RED BLUE`, embora `target.read()` devolva `''` porque a posição continua no fim.

Lições relacionadas

  • Python · Lição 32 · Intermédio · Versão: 3

Fontes