Word (DOCX)

Leitura e escrita de documentos Word

Abrir Documento

word.open_document

Abre arquivo .docx

Como usar

Abre um arquivo .docx e guarda o documento na variável usada pelos demais comandos. Não precisa do Word instalado.

Exemplo: Abra C:\Modelos\contrato.docx em {document}.

Campos

CampoTipoPadrãoDetalhes
Arquivo Word *Arquivo
Salvar resultado na variável *Variável de saídadocument

Resultado: guardado na variável document (Objeto).

Criar Documento

word.create_document

Cria novo documento Word

Como usar

Cria um documento novo, em branco ou a partir de um modelo .docx (que traz estilos, cabeçalho e rodapé).

Exemplo: Crie {document} a partir de modelo_relatorio.docx.

Campos

CampoTipoPadrãoDetalhes
Modelo (opcional)Arquivo
Salvar resultado na variável *Variável de saídadocument

Resultado: guardado na variável document (Objeto).

Adicionar Parágrafo

word.add_paragraph

Adiciona texto com estilo

Como usar

Acrescenta um parágrafo ao fim do documento com estilo (título, subtítulos, lista, citação), negrito, itálico, tamanho e alinhamento.

Exemplo: Adicione "Relatório de {mes}" com o estilo title e centralizado.

Campos

CampoTipoPadrãoDetalhes
Documento *Variáveldocument
Texto *Texto (várias linhas)
EstiloOpçãoNormalOpções: Normal, Título, Título 1, Título 2, Título 3, Lista com marcadores, Lista numerada, Citação
+ Avançado (4)
CampoTipoPadrãoDetalhes
NegritoSim/NãoNão
ItálicoSim/NãoNão
Tamanho da fonte (vazio = do estilo)Número
AlinhamentoOpçãoEsquerdaOpções: Esquerda, Centro, Direita, Justificado

Adicionar Tabela

word.add_table

Insere tabela

Como usar

Insere uma tabela a partir de uma lista de linhas ou tabela de dados (DataFrame), com a primeira linha como cabeçalho e um estilo do Word.

Exemplo: Adicione {df_resumo} como tabela com o estilo Table Grid.

Campos

CampoTipoPadrãoDetalhes
Documento *Variáveldocument
Dados *TextoDataFrame, lista de dicionários ou lista de listasEx.: {df}
Primeira linha com o cabeçalhoSim/NãoSim
+ Avançado (1)
CampoTipoPadrãoDetalhes
Estilo da tabelaTextoTable Grid

Adicionar Imagem

word.add_image

Insere imagem no documento

Como usar

Insere uma imagem no fim do documento, com largura opcional em centímetros.

Exemplo: Adicione grafico.png com 15 cm de largura.

Campos

CampoTipoPadrãoDetalhes
Documento *Variáveldocument
Imagem *Arquivo
Largura (vazio = original)Número

Ler Parágrafos

word.read_paragraphs

Lê todos os parágrafos

Como usar

Lê os parágrafos do documento como lista ou como um texto único.

Exemplo: Leia os parágrafos de {document} como texto e procure a cláusula de vigência.

Campos

CampoTipoPadrãoDetalhes
Documento *Variáveldocument
RetornarOpçãoLista de parágrafosOpções: Lista de parágrafos, Todo o texto (um parágrafo por linha)
Incluir parágrafos vaziosSim/NãoNão
Salvar resultado na variável *Variável de saídaparagraphs

Resultado: guardado na variável paragraphs (Qualquer).

Ler Tabelas

word.read_tables

Lê dados das tabelas

Como usar

Lê uma tabela do documento (ou todas) como lista de linhas ou de dicionários pelo cabeçalho.

Exemplo: Leia a tabela 1 de {document} como records e percorra os itens do pedido.

Campos

CampoTipoPadrãoDetalhes
Documento *Variáveldocument
Número da tabela (1 = primeira; 0 = todas)Número1
FormatoOpçãoLista de linhas ([[...], ...])Opções: Lista de linhas ([[...], ...]), Dicionários usando a 1ª linha como cabeçalho
Salvar resultado na variável *Variável de saídatable

Resultado: guardado na variável table (Lista).

Buscar e Substituir

word.find_replace

Busca e substitui texto

Como usar

Troca textos no documento inteiro (inclusive tabelas, cabeçalho e rodapé), como preencher marcadores de um modelo, e pode guardar quantas trocas fez.

Exemplo: Troque [NOME] por {cliente} e [DATA] por {data_hoje} no modelo do contrato.

Campos

CampoTipoPadrãoDetalhes
Documento *Variáveldocument
Procurar → substituir por *Pares chave e valorVale também em tabelas, cabeçalhos e rodapés. Ótimo para preencher modelos: [NOME] → {nome}
Salvar o nº de substituições na variávelVariável de saída

Resultado: guardado na variável escolhida (Número).

Salvar Documento

word.save_document

Salva o documento

Como usar

Salva o documento no mesmo arquivo ou num novo caminho.

Exemplo: Salve como C:\Contratos\contrato_{cliente}.docx.

Campos

CampoTipoPadrãoDetalhes
Documento *Variáveldocument
Salvar como (vazio = o mesmo arquivo)Arquivo

Converter para PDF

word.convert_to_pdf

Converte DOCX para PDF (requer Word instalado)

Como usar

Converte um .docx em PDF usando o Word instalado na máquina, mantendo a formatação.

Exemplo: Converta contrato_{cliente}.docx em PDF para enviar ao cliente.

Campos

CampoTipoPadrãoDetalhes
Arquivo Word (.docx) *Arquivo
Arquivo PDF (vazio = mesmo nome)Arquivo
Salvar o caminho do PDF na variávelVariável de saída

Resultado: guardado na variável escolhida (Texto).