Guia do Desenvolvedor

Aspose.Note FOSS for Python is a free, open-source library for reading Microsoft OneNote .one arquivos de seção sem qualquer dependência do Microsoft Office. Ele fornece uma API pública limpa sob o aspose.note pacote, modelado após a interface Aspose.Note para .NET. A biblioteca é adequada para automação de documentos, indexação de conteúdo, pipelines de extração de dados e fluxos de trabalho de arquivamento.

Este guia do desenvolvedor cobre toda a superfície da API pública disponível na versão 26.3.1, com exemplos de código executáveis para cada recurso principal.

Carregamento de Documento

Carregue um .one arquivo a partir de um caminho de arquivo ou de um fluxo binário. O Document classe é o ponto de entrada para todas as operações.

Carregar a partir de um caminho de arquivo

from aspose.note import Document

doc = Document("MyNotes.one")

Carregar a partir de um fluxo binário

Útil ao ler de armazenamento em nuvem, respostas HTTP ou buffers em memória:

from pathlib import Path
from aspose.note import Document

with Path("MyNotes.one").open("rb") as f:
    doc = Document(f)

Opções de carregamento

Use LoadOptions para definir parâmetros opcionais no momento da carga:

from aspose.note import Document, LoadOptions

opts = LoadOptions()
opts.LoadHistory = True   # Include page history in the DOM
doc = Document("MyNotes.one", opts)

Nota: DocumentPassword existe em LoadOptions para compatibilidade de API, mas documentos criptografados não são suportados. Tentar carregar um arquivo criptografado gera IncorrectPasswordException.


Estrutura do Documento (DOM)

O modelo de documento OneNote é uma árvore:

Document
  └── Page (0..n)
        ├── Title
        │     ├── TitleText (RichText)
        │     ├── TitleDate (RichText)
        │     └── TitleTime (RichText)
        └── Outline (0..n)
              └── OutlineElement (0..n)
                    ├── RichText
                    ├── Image
                    ├── Table
                    │     └── TableRow
                    │           └── TableCell
                    │                 └── RichText / Image
                    └── AttachedFile

Cada nó expõe ParentNode e um Document propriedade que percorre até a raiz. Nós compostos suportam iteração de filhos, FirstChild, LastChild, AppendChildLast, InsertChild, RemoveChild, e GetChildNodes(Type).


Iterando Páginas

Páginas são os filhos diretos de Document. Itere-as diretamente ou use GetChildNodes:

from aspose.note import Document, Page

doc = Document("MyNotes.one")

for page in doc:
    title = page.Title.TitleText.Text if page.Title and page.Title.TitleText else "(untitled)"
    author = page.Author or "(unknown)"
    print(f"  {title}  [by {author}]")

Metadados da página:

PropriedadeTipoDescrição
Title`TitleNone`
Author`strNone`
CreationTime`datetimeNone`
LastModifiedTime`datetimeNone`
Level`intNone`

Extração de Texto

Extrair todo o texto simples

from aspose.note import Document, RichText

doc = Document("MyNotes.one")
all_text = [rt.Text for rt in doc.GetChildNodes(RichText) if rt.Text]
print("\n".join(all_text))

Inspecionar execuções de formatação

Cada RichText contém uma lista de TextRun segmentos. Cada execução carrega seu próprio TextStyle:

from aspose.note import Document, RichText

doc = Document("FormattedNotes.one")
for rt in doc.GetChildNodes(RichText):
    for run in rt.TextRuns:
        style = run.Style
        flags = []
        if style.IsBold: flags.append("bold")
        if style.IsItalic: flags.append("italic")
        if style.IsHyperlink: flags.append(f"link={style.HyperlinkAddress}")
        print(f"{run.Text!r:40s} [{', '.join(flags)}]")

Extrair hiperlinks

from aspose.note import Document, RichText

doc = Document("MyNotes.one")
for rt in doc.GetChildNodes(RichText):
    for run in rt.TextRuns:
        if run.Style.IsHyperlink and run.Style.HyperlinkAddress:
            print(run.Text, "->", run.Style.HyperlinkAddress)

Extração de Imagem

from aspose.note import Document, Image

doc = Document("MyNotes.one")
for i, img in enumerate(doc.GetChildNodes(Image), start=1):
    name = img.FileName or f"image_{i}.bin"
    with open(name, "wb") as f:
        f.write(img.Bytes)
    print(f"Saved {name}  ({img.Width}x{img.Height})")

Propriedades da imagem: FileName, Bytes, Width, Height, AlternativeTextTitle, AlternativeTextDescription, HyperlinkUrl, Tags.


Análise de Tabela

from aspose.note import Document, Table, TableRow, TableCell, RichText

doc = Document("MyNotes.one")
for table in doc.GetChildNodes(Table):
    print("Column widths:", [col.Width for col in table.Columns])
    for r, row in enumerate(table.GetChildNodes(TableRow), start=1):
        cells = row.GetChildNodes(TableCell)
        row_text = [
            " ".join(rt.Text for rt in cell.GetChildNodes(RichText)).strip()
            for cell in cells
        ]
        print(f"Row {r}:", row_text)

Arquivos Anexados

from aspose.note import Document, AttachedFile

doc = Document("NotesWithAttachments.one")
for i, af in enumerate(doc.GetChildNodes(AttachedFile), start=1):
    name = af.FileName or f"attachment_{i}.bin"
    with open(name, "wb") as f:
        f.write(af.Bytes)
    print(f"Saved: {name}")

Tags e Listas Numeradas

Inspecionar itens NoteTag

from aspose.note import Document, RichText, Image, Table

doc = Document("TaggedNotes.one")
for rt in doc.GetChildNodes(RichText):
    for tag in rt.Tags:
        print(f"RichText tag: {tag.Label} icon={tag.Icon}")
for img in doc.GetChildNodes(Image):
    for tag in img.Tags:
        print(f"Image tag: {tag.Label}")

Inspecionar listas numeradas

from aspose.note import Document, OutlineElement

doc = Document("NumberedNotes.one")
for oe in doc.GetChildNodes(OutlineElement):
    nl = oe.NumberList
    if nl:
        print(f"format={nl.Format!r}")

Padrão DocumentVisitor

Usar DocumentVisitor para implementar um visitante que percorre toda a árvore do documento:

from aspose.note import Document, DocumentVisitor, Page, RichText, Image

class ContentCounter(DocumentVisitor):
    def __init__(self):
        self.pages = 0
        self.texts = 0
        self.images = 0

    def VisitPageStart(self, page: Page) -> None:
        self.pages += 1

    def VisitRichTextStart(self, rt: RichText) -> None:
        self.texts += 1

    def VisitImageStart(self, img: Image) -> None:
        self.images += 1

doc = Document("MyNotes.one")
counter = ContentCounter()
doc.Accept(counter)
print(f"Pages: {counter.pages}, Texts: {counter.texts}, Images: {counter.images}")

Exportação PDF

A exportação PDF requer a dependência opcional ReportLab. Instale-a com:

pip install "aspose-note[pdf]"

Exportação básica de PDF

from aspose.note import Document, SaveFormat

doc = Document("MyNotes.one")
doc.Save("output.pdf", SaveFormat.Pdf)

Exportação de PDF com opções

import io
from aspose.note import Document, SaveFormat
from aspose.note.saving import PdfSaveOptions

doc = Document("MyNotes.one")

##With save options
opts = PdfSaveOptions()
doc.Save("output.pdf", opts)

##Save to in-memory stream
buf = io.BytesIO()
doc.Save(buf, PdfSaveOptions())
pdf_bytes = buf.getvalue()

Observação: PdfSaveOptions.PageIndex e PageCount campos existem, mas não são encaminhados para o exportador PDF na v26.3.1. O documento inteiro é sempre exportado.


Limitações atuais

ÁreaStatus
Leitura .one arquivosTotalmente suportado
Exportação de PDF (via ReportLab)Suportado
Escrevendo de volta para .oneNão implementado
Documentos criptografadosNão suportado (levanta IncorrectPasswordException)
HTML / imagem / formatos de salvamento ONEDeclarado para compatibilidade de API; raise UnsupportedSaveFormatException

Guias Disponíveis


Veja Também

 Português