Load From a Binary Stream

from aspose.note import Document

with open("SimpleTable.one", "rb") as f:
    doc = Document(f)
print(doc.DisplayName, len(list(doc)))

Traverse Tables (Rows and Cells)

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

doc = Document("SimpleTable.one")
for table in doc.GetChildNodes(Table):
    for row in table.GetChildNodes(TableRow):
        cells = row.GetChildNodes(TableCell)
        values = [" ".join(rt.Text for rt in cell.GetChildNodes(RichText)) for cell in cells]
        print(values)

Extract Attached Files

from pathlib import Path
from aspose.note import Document, AttachedFile

doc = Document("OnePageWithFile.one")
for i, af in enumerate(doc.GetChildNodes(AttachedFile), start=1):
    name = af.FileName or f"attachment_{i}.bin"
    Path(name).write_bytes(af.Bytes)

Inspect OneNote Tags

from aspose.note import Document, RichText

doc = Document("TagSizes.one")
for rt in doc.GetChildNodes(RichText):
    for tag in rt.Tags:
        print(tag.Label, tag.Status)

Count Nodes With a DocumentVisitor

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

class Counter(DocumentVisitor):
    def __init__(self):
        self.pages = 0
        self.rich_texts = 0
        self.images = 0

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

    def VisitRichTextStart(self, rich_text: RichText) -> None:
        self.rich_texts += 1

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

doc = Document("3ImagesWithDifferentAlignment.one")
counter = Counter()
doc.Accept(counter)
print(counter.pages, counter.rich_texts, counter.images)

Extract All Text

from aspose.note import Document, RichText

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

Export to PDF With Custom Options

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

doc = Document("TagSizes.one")
opts = PdfSaveOptions(JpegQuality=90)
doc.Save("out.pdf", opts)

Extract Hyperlinks

from aspose.note import Document, RichText

doc = Document("FormattedRichText.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)

Inspect Numbered Lists

from aspose.note import Document, OutlineElement

doc = Document("NumberedListWithTags.one")
for oe in doc.GetChildNodes(OutlineElement):
    nl = oe.NumberList
    if nl is None:
        continue
    print("format=", nl.Format, "number_format=", nl.NumberFormat, "restart=", nl.Restart)

Core API

Enumerations

Saving

Detailed Member Reference

Document and Traversal

• Document(source=None, load_options=None)
  • DisplayName: str | None, CreationTime: datetime | None
  • FileFormat -> FileFormat — always reports OneNote2010, see Scope and Limitations
  • iteration: for page in doc: ...
  • GetPageHistory(page) -> PageHistory
  • DetectLayoutChanges() — compatibility stub, see Scope and Limitations
  • Save(target, format_or_options=None) — SaveFormat.Pdf only
• PageHistory
  • Current: Page, Count: int, IsReadOnly: bool
  • Add(page), AddRange(pages), Remove(page), RemoveAt(index), iteration/indexing
• DocumentVisitor — base visitor:
  • VisitDocumentStart/End, VisitPageStart/End, VisitTitleStart/End, VisitOutlineStart/End, VisitOutlineElementStart/End, VisitRichTextStart/End, VisitImageStart/End
• Node
  • ParentNode: Node | None, Document: Document | None, Accept(visitor)
• Container nodes (Document, Page, Title, Outline, OutlineElement, Image, Table, TableRow, TableCell)
  • FirstChild, LastChild
  • AppendChildLast(node), AppendChildFirst(node), InsertChild(index, node), RemoveChild(node)
  • iteration for child in node: ...
  • GetChildNodes(node_type) -> list[TNode] — recursive search by type

Document Structure

• Page
  • Title: Title | None, Author: str | None
  • CreationTime: datetime | None, LastModifiedTime: datetime | None, Level: int | None
  • Clone(cloneHistory=False) -> Page
• Title
  • TitleText: RichText | None, TitleDate: RichText | None, TitleTime: RichText | None
• Outline
  • HorizontalOffset, VerticalOffset, MaxWidth, MaxHeight, MinWidth, ReservedWidth, IndentPosition, DescendantsCannotBeMoved, LastModifiedTime
• OutlineElement
  • NumberList: NumberList | None

Content

• RichText(Node)
  • Text: str, TextRuns: list[TextRun], ParagraphStyle: ParagraphStyle, Length: int
  • Alignment: HorizontalAlignment | None, Tags: list[NoteTag]
  • Append(text, style=None), Insert(index, text, style=None), Remove(start, count), Replace(old_value, new_value, style=None), Trim()/TrimStart()/TrimEnd(), IndexOf(value, startIndex, count, comparison) -> int
• TextRun
  • Text: str, Style: TextStyle
• ParagraphStyle
  • default paragraph-level text formatting; ParagraphStyle.Default() -> ParagraphStyle
• TextStyle
  • IsBold/IsItalic/IsUnderline/IsStrikethrough/IsSuperscript/IsSubscript: bool, IsHidden: bool, IsMathFormatting: bool
  • FontName: str | None, FontSize: float | None, FontColor: int | None, Highlight: int | None, Language: int | None
  • IsHyperlink: bool, HyperlinkAddress: str | None, FontStyle: int
  • TextStyle.Default(), .DefaultMsOneNoteTitleTextStyle(), .DefaultMsOneNoteTitleDateStyle(), .DefaultMsOneNoteTitleTimeStyle()
• Image
  • FileName: str | None, Bytes: bytes, Width, Height
  • AlternativeTextTitle, AlternativeTextDescription, HyperlinkUrl, Tags: list[NoteTag]
  • Replace(image) -> None
• AttachedFile(Node)
  • FileName: str | None, Bytes: bytes, Tags: list[NoteTag]
• Table
  • Columns: list[TableColumn], IsBordersVisible, Tags: list[NoteTag]
• TableColumn
  • Width: float | None, LockedWidth: bool
• NoteTag
  • Label, Icon, Status: TagStatus, Highlight, CreationTime, CompletedTime, FontColor
  • NoteTag.CreateYellowStar(label), .CreateQuestionMark(label), .CreateMusicalNote(label)
• NumberList
  • Format, NumberFormat, Font, FontSize, FontColor, IsBold, IsItalic, Restart
  • GetNumberedListHeader(number) -> str

Load and Save Options

• LoadOptions
  • DocumentPassword: str | None — not supported, see Scope and Limitations
  • LoadHistory: bool
• SaveOptions (base)
  • SaveFormat: SaveFormat, PageIndex: int, PageCount: int | None, FontsSubsystem
• PdfSaveOptions(SaveOptions)
  • ImageCompression, JpegQuality, PageSettings, PageSplittingAlgorithm

Licensing

• License.SetLicense(license_path_or_stream) — no-op in this edition, see Scope and Limitations
• Metered.SetMeteredKey(public_key, private_key) — no-op in this edition, see Scope and Limitations

Enumerations

• FileFormat: Unknown, OneNote2010, OneNoteOnline, OneNote2007
• SaveFormat: Pdf
• HorizontalAlignment: Left, Center, Right
• NodeType: Document, Page, Outline, OutlineElement, RichText, Image, Table, AttachedFile
• TagStatus: Open, Completed, Disabled

Exceptions

All inherit from AsposeNoteError.

• AsposeNoteError — base exception for the library
• FileCorruptedException — the OneStore container is malformed
• IncorrectDocumentStructureException — the parsed object graph doesn't match the expected structure
• IncorrectPasswordException — a password was supplied; password-protected documents aren't supported
• UnsupportedFileFormatException — the source isn't a recognized OneNote format (carries FileFormat)
• UnsupportedSaveFormatException — Document.Save() was called with anything other than SaveFormat.Pdf

The PDF golden-output tests (tests.test_aspose_note_pdf_goldens) compare generated PDFs against manifests in tests/goldens/pdf/, not raw bytes, so they stay stable across platforms and ReportLab internals. The PDF writer uses deterministic Base-14 fonts by default; set ASPOSE_NOTE_PDF_USE_SYSTEM_FONTS=1 before export if you want to try Windows system fonts for local inspection instead:

python -m unittest tests.test_aspose_note_pdf_goldens -v

On a mismatch, the generated PDFs and manifests are written to tests/out/pdf_golden_failures/ for inspection. If PyMuPDF is installed, the failing test also renders baseline/generated pages to PNG and writes visual diff artifacts into the same output tree; if PyMuPDF is unavailable but pdftoppm is on PATH, the tests fall back to pdftoppm as the renderer.

Regenerate the golden baselines after an intentional PDF-output change with tools/regenerate_pdf_goldens.py:

python tools/regenerate_pdf_goldens.py

Regenerate only selected cases:

python tools/regenerate_pdf_goldens.py --case formatted_richtext --case simple_table

Runnable example scripts have their own setup and usage notes in examples/README.md. publish-pypi.yml shows the exact release-time commands this project runs in CI.