Skip to content
PDF Oxide

Referencia de la API Page

Desde v0.3.34, cada binding expone un objeto Page para que puedas iterar un documento y llamar los métodos de extracción directamente sobre la página, en lugar de pasar page_index en cada llamada. El tipo se llama Page de forma consistente en Python, Node.js, C# y Go; Rust expone la misma forma mediante PdfPage.

Ejemplo rápido

Python

from pdf_oxide import PdfDocument

with PdfDocument("paper.pdf") as doc:
    for page in doc:                       # len(doc), doc[i], doc[-1] también funcionan
        print(page.text[:80])
        md = page.markdown(detect_headings=True)

Rust

use pdf_oxide::api::Pdf;

let mut doc = Pdf::open("paper.pdf")?;
for i in 0..doc.page_count()? {
    let page = doc.page(i)?;
    println!("{}", &page.text()?[..80]);
}

JavaScript / TypeScript (Node)

const { PdfDocument } = require("pdf-oxide");

const doc = new PdfDocument("paper.pdf");
for (const page of doc) {
  console.log(page.extractText().slice(0, 80));
}
doc.close();

Go

package main

import (
    "fmt"
    "log"
    pdfoxide "github.com/yfedoseev/pdf_oxide/go"
)

func main() {
    doc, err := pdfoxide.Open("paper.pdf")
    if err != nil { log.Fatal(err) }
    defer doc.Close()

    pages, _ := doc.Pages()
    for _, page := range pages {
        text, _ := page.ExtractText()
        fmt.Println(text[:80])
    }
}

C#

using PdfOxide;

using var doc = PdfDocument.Open("paper.pdf");
foreach (var page in doc.Pages)
{
    Console.WriteLine(page.ExtractText()[..Math.Min(80, page.ExtractText().Length)]);
}

Python — Page

Superficie de propiedades perezosas: el contenido se analiza en el primer acceso y queda en caché dentro de Page.

Miembro Retorna Descripción
page.text str Texto extraído (consciente de columnas)
page.chars list[Char] Registros por carácter con bbox y fuente
page.words list[Word] Registros por palabra con bbox
page.lines list[TextLine] Líneas de texto con bbox
page.spans list[Span] Spans con estilo (fuente, tamaño, peso)
page.tables list[Table] Filas estructuradas de tabla con bbox por celda
page.images list[Image] Metadatos de imágenes
page.paths list[Path] Registros de trazos vectoriales
page.annotations list[Annotation] Anotaciones en esta página
page.markdown(detect_headings=True) str Conversión a Markdown
page.plain_text() str Texto plano (sin pistas de layout)
page.html() str Conversión a HTML
page.render(format="png") bytes Renderiza la página como PNG / JPEG
page.search(term, case_sensitive=False) list[SearchResult] Busca texto en esta página
page.region(rect) PageRegion Extracción acotada dentro de un rectángulo 
with PdfDocument("paper.pdf") as doc:
    page = doc[0]                 # o doc.page(0)
    for word in page.words:       # el primer acceso parsea; las llamadas siguientes usan el caché
        print(word.text, word.bbox)

    # Extracción acotada
    header = page.region((0, 700, 612, 92)).extract_text()

La clase editor PdfPage preexistente (para escribir) no cambia; la nueva Page es estrictamente de solo lectura.

Rust — PdfPage

use pdf_oxide::api::Pdf;

let mut doc = Pdf::open("paper.pdf")?;
let page = doc.page(0)?;

let text = page.text()?;
let words = page.extract_words()?;
let tables = page.extract_tables()?;
let md = page.to_markdown(true)?;

Métodos disponibles en PdfPage:

  • text(), plain_text(), to_markdown(detect_headings), to_html()
  • extract_chars(), extract_words(), extract_lines(), extract_spans()
  • extract_tables(), extract_paths(), extract_images()
  • annotations(), render(format)
  • search(term) — búsqueda acotada
  • find_text_containing(substring) — lista de coincidencias a nivel DOM con IDs

Node.js — Page

const { PdfDocument } = require("pdf-oxide");

const doc = new PdfDocument("paper.pdf");
const page = doc.page(0);

console.log(page.width, page.height, page.rotation);  // en caché
console.log(page.extractText());
const words = page.extractWords();
const tables = page.extractTables();
const md = page.toMarkdown();

PdfDocument soporta for..of vía Symbol.iterator, además de doc.page(i) y doc.pageCount().

Seis métodos que antes solo estaban en la capa nativa ahora están disponibles tanto en Page como en PdfDocument a través de la capa TS:

  • extractWords
  • extractTextLines
  • extractTables
  • extractPaths
  • getEmbeddedImages
  • ocrExtractText

Cada método tiene su versión async — extractTextAsync, toMarkdownAsync, etc.

Go — Page

doc, _ := pdfoxide.Open("paper.pdf")
defer doc.Close()

page, _ := doc.Page(0)
text, _ := page.ExtractText()
md, _   := page.ToMarkdown()
tables, _ := page.ExtractTables()

// Itera todas las páginas
all, _ := doc.Pages()
for i, p := range all {
    t, _ := p.ExtractText()
    fmt.Printf("página %d: %d caracteres\n", i, len(t))
}

El struct Page de Go tiene la superficie completa: ExtractText, ToMarkdown, ToHtml, ToPlainText, ExtractWords, ExtractTextLines, ExtractTables, ExtractChars, ExtractPaths, Annotations, Images, Fonts, RenderPage, Search.

C# — Page

using PdfOxide;

using var doc = PdfDocument.Open("paper.pdf");

Page page = doc[0];                            // o doc.Pages[0] o doc.Page(0)
string text = page.ExtractText();
string md   = page.ToMarkdown();
Table[] tables = page.ExtractTables();

// Variantes async
string textAsync = await page.ExtractTextAsync();
string mdAsync   = await page.ToMarkdownAsync();

doc.Pages es IReadOnlyList<Page>. Cada método síncrono tiene su contraparte async Task<T> con soporte para CancellationToken.

Forma del tipo Table

extract_tables() (disponible tanto en PdfDocument como en Page) devuelve un tipo Table consistente entre lenguajes:

Lenguaje Tipo Acceso a celdas
Rust Table iterar rows[i].cells[j]
Python dict row["cells"][i]["text"]
Go Table table.CellText(row, col)
C# Table table.CellText(row, col)
Node.js interfaz Table table.cells[row][col]

Cada celda lleva texto más una bounding box, así que puedes correlacionar la extracción con las coordenadas en la página.

Migración desde doc.extract_*(page_index)

Antiguo (aún soportado):

doc = PdfDocument("paper.pdf")
for i in range(doc.page_count()):
    print(doc.extract_text(i))
    print(doc.to_markdown(i, detect_headings=True))
    print(doc.extract_tables(i))

Nuevo (v0.3.34+):

with PdfDocument("paper.pdf") as doc:
    for page in doc:
        print(page.text)
        print(page.markdown(detect_headings=True))
        print(page.tables)

Ambos estilos siguen soportados; el estilo Page se lee mejor para pipelines página-por-página y evita llevar la cuenta del índice.

Páginas relacionadas