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

CKTIS / Python

io.StringIO: ler, escrever e obter todo o conteúdo do buffer

Usa `read()` para ler a partir da posição atual, `write()` para construir a saída por partes e `getvalue()` para obter todo o texto sem alterar a posição.

Versão: Python 3.12

Sintaxe

io.StringIO(initial_value='', newline='\n')

Methods on a StringIO instance (signature notation):
read(size=-1, /) -> str
write(s, /) -> int
getvalue() -> str

Em Python 3.12, io.StringIO é um fluxo de texto em memória, não um ficheiro no disco. Podes fornecer texto inicial como entrada e usar outro fluxo, vazio, para acumular a saída. A posição inicial fica no início do buffer, mesmo que este já contenha texto.

read() devolve um str desde a posição atual até ao fim e avança a posição para além do texto lido. read(n) lê no máximo n caracteres se n não for negativo. No fim do fluxo, read() devolve ''. write(s) escreve um str na posição atual, avança a posição e devolve o número de caracteres escritos. Nem sempre acrescenta texto no fim: pode substituir texto existente. Passar bytes a write() provoca uma exceção TypeError.

getvalue() não recebe argumentos e devolve todo o conteúdo do buffer como str, independentemente da posição atual. Não altera a posição nem esvazia o buffer, pelo que não é preciso chamar seek(0). As quebras de linha são interpretadas como em read(), de acordo com a definição de newline.

Obtém o resultado antes de sair do bloco with: ao fechar o fluxo, o buffer é descartado e qualquer chamada posterior a getvalue() provoca uma exceção. O str já obtido continua disponível.

Exemplos

import io

with io.StringIO("go") as src, io.StringIO() as dst:
    text = src.read()
    dst.write("[")
    dst.write(text.upper() + "]")

    position = dst.tell()
    result = dst.getvalue()
    assert dst.tell() == position
    print(repr(dst.read()))

print(result)

Resultado

''
[GO]

O exemplo lê `go` e constrói `[GO]` com duas escritas. `getvalue()` obtém todo o resultado sem alterar a posição. A chamada seguinte a `read()` devolve `''` porque a posição continua no fim. É possível imprimir o resultado guardado depois de fechar o fluxo.

Lições relacionadas

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

Fontes