Die Ausgabeschnittstelle von Aspose.TeX | Python

Formale Definitionen der E/A-Implementierung finden Sie in der API-Referenz von Aspose.TeX für Python.

Die Idee hinter dem Ausgabeverzeichnis

Aspose.TeX definiert ein Verzeichnis als eine Zuordnung zwischen Namen und Datenmengen, wobei die Datenmengen Dateien, Streams, Arrays oder andere Datentypen sein können. Die API ermöglicht die Angabe separater Eingabe- und Ausgabearbeitsverzeichnisse. Für die Ausgabe stellt die API die allgemeine Schnittstelle IOutputWorkingDirectory zur Verfügung, die vom Benutzer für seine spezifischen Anforderungen implementiert werden kann. Darüber hinaus stellt die API gebrauchsfertige Implementierungen bereit, die im Folgenden erläutert werden. Die IOutputWorkingDirectory-Schnittstelle erweitert IInputWorkingDirectory, da die Engine zunächst eine Datei erstellen und schreiben und diese dann zurücklesen kann. Die Schnittstelle enthält die Methode get_output_file(), die den Stream zum Schreiben zurückgibt, im Gegensatz zur Methode get_file(), die den Stream zum Lesen zurückgibt.

Speichern der Ausgabe als Datei im Festplattendateisystem

Wie oben erwähnt, wird das output_working_directory üblicherweise als Instanz der Klasse OutputFileSystemDirectory festgelegt.

So würden wir es einstellen:

Setzen Sie ASPOSE_TEX_OUTPUT_DIR auf das Ausgabeverzeichnis (Standard: output). Wenden Sie zuerst eine Lizenz an. Licensing.

# Write an XPS document and its transcript to a file system directory.
import os
from pathlib import Path
from aspose.tex import Interaction, TeXConfig, TeXJob, TeXOptions
from io import BytesIO
from aspose.tex.io import OutputFileSystemDirectory, OutputMemoryTerminal
from aspose.tex.presentation.xps import XpsDevice

output_dir = Path(os.environ.get("ASPOSE_TEX_OUTPUT_DIR", "output")).resolve()
output_dir.mkdir(parents=True, exist_ok=True)

options = TeXOptions.console_app_options(TeXConfig.object_tex())
options.interaction = Interaction.NONSTOP_MODE
options.output_working_directory = OutputFileSystemDirectory(str(output_dir))
options.terminal_out = OutputMemoryTerminal()
device = XpsDevice()
with BytesIO(b"Hello, World!\\end") as input_stream:
    job_result = TeXJob(input_stream, device, options).run()

Der eingebettete plain-TeX-Stream erzeugt texput.xps und texput.log im Ausgabeverzeichnis.

Speichern der Ausgabe als ZIP-Archivdatei.

Eine andere Möglichkeit besteht darin, eine Datei oder einen Stream zu erstellen und diese als ZIP-Archiv zum Speichern der Ausgabedateien zu verwenden. Hier ist ein Beispiel:

# Write an XPS document and transcript into a finalized ZIP archive.
import os
from pathlib import Path
from aspose.tex import Interaction, TeXConfig, TeXJob, TeXOptions
from io import BytesIO
from aspose.tex.io import OutputZipDirectory, OutputMemoryTerminal
from aspose.tex.presentation.xps import XpsDevice

output_dir = Path(os.environ.get("ASPOSE_TEX_OUTPUT_DIR", "output")).resolve()
output_dir.mkdir(parents=True, exist_ok=True)

with (output_dir / "zip-xps-out.zip").open("wb") as output_stream:
    directory = OutputZipDirectory(output_stream)
    options = TeXOptions.console_app_options(TeXConfig.object_tex())
    options.interaction = Interaction.NONSTOP_MODE
    options.output_working_directory = directory
    options.terminal_out = OutputMemoryTerminal()
    try:
        device = XpsDevice()
        with BytesIO(b"Hello, World!\\end") as input_stream:
            job_result = TeXJob(input_stream, device, options).run()
    finally:
        # Write the ZIP directory before closing its underlying stream.
        directory.finish()

zip-xps-out.zip wird im Binärmodus wb geöffnet. Rufen Sie finish() auf OutputZipDirectory auf, bevor der Stream geschlossen wird. Das Archiv enthält texput.xps und texput.log.

Zunächst erstellen wir einen Ausgabestream für die ZIP-Datei. Nachdem wir die Konvertierungsoptionen erstellt haben, legen wir dann die Option output_working_directory als Instanz der Klasse OutputZipDirectory fest.

Die Idee hinter dem Ausgabeterminal

Die Terminalausgabe ist ein weiterer wichtiger Aspekt der Ausgabe. Zu diesem Zweck definiert Aspose.TeX für Python die allgemeine Schnittstelle IOutputTerminal, die über eine einzelne Eigenschaft verfügt, die eine Instanz der TerminalWriter-Implementierung zurückgibt. Die verfügbaren Implementierungen werden im Folgenden erläutert.

Schreiben der Terminalausgabe in die Konsole

Um dies zu erreichen, müssen wir die Option terminal_out als Instanz der Klasse OutputConsoleTerminal festlegen.

# Write TeX terminal output to the console.
import os
from pathlib import Path
from aspose.tex import Interaction, TeXConfig, TeXJob, TeXOptions
from io import BytesIO
from aspose.tex.io import OutputFileSystemDirectory, OutputConsoleTerminal
from aspose.tex.presentation.xps import XpsDevice

output_dir = Path(os.environ.get("ASPOSE_TEX_OUTPUT_DIR", "output")).resolve()
output_dir.mkdir(parents=True, exist_ok=True)

options = TeXOptions.console_app_options(TeXConfig.object_tex())
options.interaction = Interaction.NONSTOP_MODE
options.output_working_directory = OutputFileSystemDirectory(str(output_dir))
options.terminal_out = OutputConsoleTerminal()
device = XpsDevice()
with BytesIO(b"Hello, World!\\end") as input_stream:
    job_result = TeXJob(input_stream, device, options).run()

Auch hier handelt es sich um den Standardwert der Option, sodass keine wirkliche Notwendigkeit besteht, ihn anzugeben. Daher dient dieser Abschnitt ausschließlich zu Demonstrationszwecken.

Terminalausgabe in eine Datei schreiben

Im Gegensatz zum Eingabeterminal enthält Aspose.TeX für Python eine Implementierung der IOutputTerminal-Schnittstelle, die es uns ermöglicht, die Terminalausgabe in eine Datei innerhalb eines angegebenen Ausgabeverzeichnisses zu schreiben.

# Write TeX terminal output to a .trm file.
import os
from pathlib import Path
from aspose.tex import Interaction, TeXConfig, TeXJob, TeXOptions
from io import BytesIO
from aspose.tex.io import OutputFileSystemDirectory, OutputFileTerminal
from aspose.tex.presentation.xps import XpsDevice

output_dir = Path(os.environ.get("ASPOSE_TEX_OUTPUT_DIR", "output")).resolve()
output_dir.mkdir(parents=True, exist_ok=True)

options = TeXOptions.console_app_options(TeXConfig.object_tex())
options.interaction = Interaction.NONSTOP_MODE
options.output_working_directory = OutputFileSystemDirectory(str(output_dir))
options.terminal_out = OutputFileTerminal(options.output_working_directory)
device = XpsDevice()
with BytesIO(b"Hello, World!\\end") as input_stream:
    job_result = TeXJob(input_stream, device, options).run()

OutputFileTerminal erhält das Ausgabearbeitsverzeichnis im Konstruktor und schreibt dort texput.trm neben texput.xps und texput.log.