Struct python_packaging::zip_app_builder::ZipAppBuilder

pub struct ZipAppBuilder { /* fields omitted */ }

Interface for building .zip file based Python applications.

This type implements functionality provided by the Python stdlib zipapp module. It is used to produce zip files containing Python resources (notably module source and bytecode) that Python interpreters can execute as standalone applications.

The zip archives can contain a shebang line (#!<interpreter>) denoting a program to use to execute the zipapp. This is typically python or some such variant.

Implementations

impl ZipAppBuilder

pub fn interpreter(&self) -> Option<&str>

Obtain the interpreter to use in the shebang line.

pub fn set_interpreter(&mut self, v: impl ToString)

Set the interpreter to use in the shebang line.

pub fn modified_time(&self) -> OffsetDateTime

Obtain the modified time for files in the wheel archive.

pub fn set_modified_time(&mut self, v: OffsetDateTime)

Set the modified time for files in the wheel archive.

pub fn set_bytecode_compiler(&mut self, v: Box<dyn PythonBytecodeCompiler>)

Set the Python bytecode compiler to use to turn source code into bytecode.

pub fn optimize_level(&self) -> BytecodeOptimizationLevel

Obtain the bytecode optimization level used when generating Python bytecode.

pub fn set_optimize_level(&mut self, v: BytecodeOptimizationLevel)

Set the bytecode optimization level used when generating Python bytecode.

pub fn add_file_entry(
    &mut self,
    path: impl AsRef<Path>,
    entry: impl Into<FileEntry>
) -> Result<()>

Add a file to the zip archive.

This is the lowest level mechanism to add an entry to the zip archive. The path/file will be added without modification.

pub fn add_python_module_source(
    &mut self,
    source: &PythonModuleSource,
    prefix: &str
) -> Result<()>

Add Python module source code to the archive.

This only adds source code, not bytecode.

pub fn add_python_module_source_and_bytecode(
    &mut self,
    source: &PythonModuleSource,
    prefix: &str
) -> Result<()>

Add Python module source and corresponding bytecode to the archive.

This will automatically compile bytecode at the specified optimization level given the source code provided.

pub fn add_python_module_bytecode(
    &mut self,
    bytecode: &PythonModuleBytecode,
    prefix: &str
) -> Result<()>

Add Python module bytecode, without corresponding source code.

pub fn add_main(&mut self, module: &str, func: &str, prefix: &str) -> Result<()>

Define the function called when the zip-based application is executed.

This defines a __main__.py[c] that invokes the func function in the module module.

pub fn write_zip_app(&self, writer: &mut impl Write + Seek) -> Result<()>

Writes zip archive data to a writer.

This will emit a zip archive + optional leading shebang so it is runnable as a standalone executable file.

pub fn write_to_path(&self, path: impl AsRef<Path>) -> Result<()>

Write the zip archive to a filesystem path.

Trait Implementations

impl Default for ZipAppBuilder

fn default() -> Self

Returns the “default value” for a type.