Allow passing typst template file as bytes

Author: messense

python/typst/__init__.pyi

@@ -1,22 +1,22 @@
 import pathlib
 from typing import List, Optional, TypeVar, overload, Dict, Union, Literal
 
-PathLike = TypeVar("PathLike", str, pathlib.Path)
+Input = TypeVar("Input", str, pathlib.Path, bytes)
 OutputFormat = Literal["pdf", "svg", "png", "html"]
 
 class Compiler:
     def __init__(
         self,
-        input: PathLike,
-        root: Optional[PathLike] = None,
-        font_paths: List[PathLike] = [],
+        input: Input,
+        root: Optional[Input] = None,
+        font_paths: List[Input] = [],
         ignore_system_fonts: bool = False,
         sys_inputs: Dict[str, str] = {},
         pdf_standards: Optional[Union[Literal["1.7", "a-2b", "a-3b"], List[Literal["1.7", "a-2b", "a-3b"]]]] = []
     ) -> None:
         """Initialize a Typst compiler.
         Args:
-            input (PathLike): Project's main .typ file.
+            input: .typ file bytes or path to project's main .typ file.
             root (Optional[PathLike], optional): Root path for the Typst project.
             font_paths (List[PathLike]): Folders with fonts.
             ignore_system_fonts (bool): Ignore system fonts.
@@ -25,7 +25,7 @@ class Compiler:
 
     def compile(
         self,
-        output: Optional[PathLike] = None,
+        output: Optional[Input] = None,
         format: Optional[OutputFormat] = None,
         ppi: Optional[float] = None,
     ) -> Optional[Union[bytes, List[bytes]]]:
@@ -59,10 +59,10 @@ class Compiler:
 
 @overload
 def compile(
-    input: PathLike,
-    output: PathLike,
-    root: Optional[PathLike] = None,
-    font_paths: List[PathLike] = [],
+    input: Input,
+    output: Input,
+    root: Optional[Input] = None,
+    font_paths: List[Input] = [],
     ignore_system_fonts: bool = False,
     format: Optional[OutputFormat] = None,
     ppi: Optional[float] = None,
@@ -71,21 +71,21 @@ def compile(
 ) -> None: ...
 @overload
 def compile(
-    input: PathLike,
+    input: Input,
     output: None = None,
-    root: Optional[PathLike] = None,
-    font_paths: List[PathLike] = [],
+    root: Optional[Input] = None,
+    font_paths: List[Input] = [],
     ignore_system_fonts: bool = False,
     format: Optional[OutputFormat] = None,
     ppi: Optional[float] = None,
     sys_inputs: Dict[str, str] = {},
     pdf_standards: Optional[Union[Literal["1.7", "a-2b", "a-3b"], List[Literal["1.7", "a-2b", "a-3b"]]]] = []
 ) -> bytes: ...
 def compile(
-    input: PathLike,
-    output: Optional[PathLike] = None,
-    root: Optional[PathLike] = None,
-    font_paths: List[PathLike] = [],
+    input: Input,
+    output: Optional[Input] = None,
+    root: Optional[Input] = None,
+    font_paths: List[Input] = [],
     ignore_system_fonts: bool = False,
     format: Optional[OutputFormat] = None,
     ppi: Optional[float] = None,
@@ -94,7 +94,7 @@ def compile(
 ) -> Optional[Union[bytes, List[bytes]]]:
     """Compile a Typst project.
     Args:
-        input (PathLike): Project's main .typ file.
+        input: .typ file bytes or path to project's main .typ file.
         output (Optional[PathLike], optional): Path to save the compiled file.
         Allowed extensions are `.pdf`, `.svg` and `.png`
         root (Optional[PathLike], optional): Root path for the Typst project.
@@ -109,19 +109,19 @@ def compile(
     """
 
 def query(
-    input: PathLike,
+    input: Input,
     selector: str,
     field: Optional[str] = None,
     one: bool = False,
     format: Optional[Literal["json", "yaml"]] = None,
-    root: Optional[PathLike] = None,
-    font_paths: List[PathLike] = [],
+    root: Optional[Input] = None,
+    font_paths: List[Input] = [],
     ignore_system_fonts: bool = False,
     sys_inputs: Dict[str, str] = {},
 ) -> str:
     """Query a Typst document.
     Args:
-        input (PathLike): Project's main .typ file.
+        input: .typ file bytes or path to project's main .typ file.
         selector (str): Typst selector like `<label>`.
         field (Optional[str], optional): Field to query.
         one (bool, optional): Query only one element.

src/compiler.rs

@@ -7,7 +7,7 @@ use typst::foundations::Datetime;
 use typst::html::HtmlDocument;
 use typst::layout::PagedDocument;
 use typst::syntax::{FileId, Source, Span};
-use typst::{World, WorldExt};
+use typst::WorldExt;
 
 use crate::world::SystemWorld;
 
@@ -21,10 +21,6 @@ impl SystemWorld {
         ppi: Option<f32>,
         pdf_standards: &[typst_pdf::PdfStandard],
     ) -> StrResult<Vec<Vec<u8>>> {
-        // Reset everything and ensure that the main file is present.
-        self.reset();
-        self.source(self.main()).map_err(|err| err.to_string())?;
-
         let Warned { output, warnings } = typst::compile(self);
 
         match output {
@@ -40,7 +36,10 @@ impl SystemWorld {
                     "png" => Ok(export_image(&document, ImageExportFormat::Png, ppi)?),
                     "svg" => Ok(export_image(&document, ImageExportFormat::Svg, ppi)?),
                     "html" => {
-                        let Warned { output, warnings } = typst::compile::<HtmlDocument>(self);
+                        let Warned {
+                            output,
+                            warnings: _,
+                        } = typst::compile::<HtmlDocument>(self);
                         Ok(vec![export_html(&output.unwrap(), self)?])
                     }
                     fmt => Err(eco_format!("unknown format: {fmt}")),
@@ -70,11 +69,10 @@ fn export_pdf(
     world: &SystemWorld,
     standards: typst_pdf::PdfStandards,
 ) -> StrResult<Vec<u8>> {
-    let ident = world.input().to_string_lossy();
     let buffer = typst_pdf::pdf(
         document,
         &typst_pdf::PdfOptions {
-            ident: typst::foundations::Smart::Custom(&ident),
+            ident: typst::foundations::Smart::Auto,
             timestamp: now().map(typst_pdf::Timestamp::new_utc),
             standards,
             ..Default::default()

src/lib.rs

@@ -43,6 +43,12 @@ mod output_template {
     }
 }
 
+#[derive(FromPyObject)]
+pub enum Input {
+    Path(PathBuf),
+    Bytes(Vec<u8>),
+}
+
 /// A typst compiler
 #[pyclass(module = "typst._typst")]
 pub struct Compiler {
@@ -104,17 +110,19 @@ impl Compiler {
         sys_inputs = HashMap::new()
     ))]
     fn new(
-        input: PathBuf,
+        input: Input,
         root: Option<PathBuf>,
         font_paths: Vec<PathBuf>,
         ignore_system_fonts: bool,
         sys_inputs: HashMap<String, String>,
     ) -> PyResult<Self> {
-        let input = input.canonicalize()?;
         let root = if let Some(root) = root {
             root.canonicalize()?
-        } else if let Some(dir) = input.parent() {
-            dir.into()
+        } else if let Input::Path(path) = &input {
+            path.canonicalize()?
+                .parent()
+                .map(Into::into)
+                .unwrap_or_else(|| PathBuf::new())
         } else {
             PathBuf::new()
         };
@@ -227,7 +235,7 @@ impl Compiler {
 #[allow(clippy::too_many_arguments)]
 fn compile(
     py: Python<'_>,
-    input: PathBuf,
+    input: Input,
     output: Option<PathBuf>,
     root: Option<PathBuf>,
     font_paths: Vec<PathBuf>,
@@ -260,7 +268,7 @@ fn compile(
 #[allow(clippy::too_many_arguments)]
 fn py_query(
     py: Python<'_>,
-    input: PathBuf,
+    input: Input,
     selector: &str,
     field: Option<&str>,
     one: bool,

src/query.rs

@@ -35,10 +35,6 @@ pub enum SerializationFormat {
 
 /// Execute a query command.
 pub fn query(world: &mut SystemWorld, command: &QueryCommand) -> StrResult<String> {
-    // Reset everything and ensure that the main file is present.
-    world.reset();
-    world.source(world.main()).map_err(|err| err.to_string())?;
-
     let Warned { output, warnings } = typst::compile(world);
 
     match output {