Příručka pro vývojáře

Aspose.Note FOSS for Python is a free, open-source library for reading Microsoft OneNote .one poskytuje čisté veřejné API pod kontrolou Microsoft Office. aspose.note Tato knihovna je vhodná pro automatizaci dokumentů, indexaci obsahu, potrubí extrakce dat a archivní pracovní postupy.

Tato příručka pro vývojáře pokrývá plný veřejný API povrch dostupný ve verzi 26.3.1, s běžnými kodexními příklady pro každou hlavní funkci.

Naložení dokumentu

Náklad a .one soubor z cesty nebo binárního proudu. Document třída je vstupním bodem pro všechny operace.

Naložení ze stezky souboru 

from aspose.note import Document

doc = Document("MyNotes.one")

Zátěž z binárního proudu

Užitečné při čtení z cloudového úložiště, HTTP odpovědí nebo paměťových bufferů:

from pathlib import Path
from aspose.note import Document

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

Možnosti zatížení

Použití: LoadOptions nastavit volitelné parametry při načítání:

from aspose.note import Document, LoadOptions

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

Poznámka:: DocumentPassword existuje na: LoadOptions Pro kompatibilitu s API, ale šifrované dokumenty nejsou podporovány. Pokoušet se načíst šiferovaný soubor zvyšuje počet kódů a zpracovává je na základě těchto informací: IncorrectPasswordException.

Struktura dokumentu (DOM)

Model dokumentu v OneNotu je strom:

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

Každý uzel je vystaven. ParentNode a a) Document Kompozitní uzly podporují dětskou iteraci., FirstChild, LastChild, AppendChildLast, InsertChild, RemoveChild,a) GetChildNodes(Type).

Iterující stránky

Stránky jsou přímými dětmi Document.Iterovat je přímo nebo používat 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}]")

Metadata stránek:

VlastnictvíTyp:Popis:
Title`TitleNone`
Author`strNone`
CreationTime`datetimeNone`
LastModifiedTime`datetimeNone`
Level`intNone`

Výběr textu

Vytáhnout všechny prosté texty 

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))

Inspekce formátování běží

Každá. RichText obsahuje seznam: TextRun Každá jízda má svůj vlastní. 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)}]")

Výňatek z hypertextových odkazů 

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)

Výběr obrázků 

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})")

Vlastnosti obrazu: FileName, Bytes, Width, Height, AlternativeTextTitle, AlternativeTextDescription, HyperlinkUrl, Tags.

Parsing tabulky 

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)

Příložené soubory 

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}")

Značky a číslované seznamy

Inspekce položky s poznámkovým štítkem 

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}")

Kontrolovat číslované seznamy 

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}")

DokumentVizitní vzor

Použití: DocumentVisitor k implementaci návštěvníka, který prochází celým stromem dokumentů:

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}")

PDF exportování

Export PDF vyžaduje volitelnou závislost ReportLab. Nainstalujte ji pomocí:

pip install aspose-note

Základní export PDF 

from aspose.note import Document, SaveFormat

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

Export PDF s možností 

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()

Poznámka:: PdfSaveOptions.PageIndex a) PageCount V případě, že jsou ve formátu v26.3.1 položky “Export” nebo “Document”, které nejsou předány PDF exportérovi.

Současná omezení

Oblast:Statutní stav
Čtení .one souboryPlně podporované
Export PDF (přístupem ReportLab)Podpořená
Píšu zpět na: .oneNeprovedené
Zašifrované dokumentyPodpora není poskytována (zvýšení) IncorrectPasswordException)
HTML / obrázek / ONE formáty uloženíProhlášeno za kompatibilní s API; zvýšit. UnsupportedSaveFormatException

Dostupné průvodce

Viz také:

 Čeština