Struct StandalonePythonExecutableBuilder

pub struct StandalonePythonExecutableBuilder { /* private fields */ }

A self-contained Python executable before it is compiled.

Implementations

impl StandalonePythonExecutableBuilder

pub fn from_distribution( host_distribution: Arc<dyn PythonDistribution>, target_distribution: Arc<StandaloneDistribution>, host_triple: String, target_triple: String, exe_name: String, link_mode: BinaryLibpythonLinkMode, packaging_policy: PythonPackagingPolicy, config: PyembedPythonInterpreterConfig, ) -> Result<Box<Self>>

Trait Implementations

impl Clone for StandalonePythonExecutableBuilder

fn clone(&self) -> StandalonePythonExecutableBuilder

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PythonBinaryBuilder for StandalonePythonExecutableBuilder

fn clone_trait(&self) -> Arc<dyn PythonBinaryBuilder>

Clone self into a Box’ed trait object.

fn name(&self) -> String

The name of the binary.

fn libpython_link_mode(&self) -> LibpythonLinkMode

How the binary will link against libpython.

fn target_triple(&self) -> &str

Rust target triple the binary will run on.

fn vc_runtime_requirements(&self) -> Option<(String, VcRedistributablePlatform)>

Obtain run-time requirements for the Visual C++ Redistributable.

fn cache_tag(&self) -> &str

Obtain the cache tag to apply to Python bytecode modules.

fn python_packaging_policy(&self) -> &PythonPackagingPolicy

Obtain the PythonPackagingPolicy for the builder.

fn host_python_exe_path(&self) -> &Path

Path to Python executable that can be used to derive info at build time.

fn target_python_exe_path(&self) -> &Path

Path to Python executable that is native to the target architecture.

fn apple_sdk_info(&self) -> Option<&AppleSdkInfo>

Apple SDK build/targeting information.

fn windows_runtime_dlls_mode(&self) -> &WindowsRuntimeDllsMode

Obtain how Windows runtime DLLs will be handled during builds.

fn set_windows_runtime_dlls_mode(&mut self, value: WindowsRuntimeDllsMode)

Set the value for windows_runtime_dlls_mode().

fn tcl_files_path(&self) -> &Option<String>

The directory to install tcl/tk files into.

fn set_tcl_files_path(&mut self, value: Option<String>)

Set the directory to install tcl/tk files into.

fn windows_subsystem(&self) -> &str

The value of the windows_subsystem Rust attribute for the generated Rust project.

fn set_windows_subsystem(&mut self, value: &str) -> Result<()>

Set the value of the windows_subsystem Rust attribute for generated Rust projects.

fn licenses_filename(&self) -> Option<&str>

Obtain the path of a filename to write containing a licensing report.

fn set_licenses_filename(&mut self, value: Option<String>)

Set the path of a filename to write containing a licensing report.

fn packed_resources_load_mode(&self) -> &PackedResourcesLoadMode

How packed Python resources will be loaded by the binary.

fn set_packed_resources_load_mode(&mut self, load_mode: PackedResourcesLoadMode)

Set how packed Python resources will be loaded by the binary.

fn iter_resources<'a>( &'a self, ) -> Box<dyn Iterator<Item = (&'a String, &'a PrePackagedResource)> + 'a>

Obtain an iterator over all resource entries that will be embedded in the binary.

fn index_package_license_info_from_resources<'a>( &mut self, resources: &[PythonResource<'a>], ) -> Result<()>

Resolve license metadata from an iterable of PythonResource and store that data.

fn pip_download( &mut self, env: &Environment, verbose: bool, args: &[String], ) -> Result<Vec<PythonResource<'_>>>

Runs pip download using the binary builder’s settings.

fn pip_install( &mut self, env: &Environment, verbose: bool, install_args: &[String], extra_envs: &HashMap<String, String>, ) -> Result<Vec<PythonResource<'_>>>

Runs pip install using the binary builder’s settings.

fn read_package_root( &mut self, path: &Path, packages: &[String], ) -> Result<Vec<PythonResource<'_>>>

Reads Python resources from the filesystem.

fn read_virtualenv(&mut self, path: &Path) -> Result<Vec<PythonResource<'_>>>

Read Python resources from a populated virtualenv directory.

fn setup_py_install( &mut self, env: &Environment, package_path: &Path, verbose: bool, extra_envs: &HashMap<String, String>, extra_global_arguments: &[String], ) -> Result<Vec<PythonResource<'_>>>

Runs python setup.py install using the binary builder’s settings.

fn add_distribution_resources( &mut self, callback: Option<ResourceAddCollectionContextCallback<'_>>, ) -> Result<Vec<AddResourceAction>>

Add resources from the Python distribution to the builder.

fn add_python_module_source( &mut self, module: &PythonModuleSource, add_context: Option<PythonResourceAddCollectionContext>, ) -> Result<Vec<AddResourceAction>>

Add a PythonModuleSource to the resources collection.

fn add_python_package_resource( &mut self, resource: &PythonPackageResource, add_context: Option<PythonResourceAddCollectionContext>, ) -> Result<Vec<AddResourceAction>>

Add a PythonPackageResource to the resources collection.

fn add_python_package_distribution_resource( &mut self, resource: &PythonPackageDistributionResource, add_context: Option<PythonResourceAddCollectionContext>, ) -> Result<Vec<AddResourceAction>>

Add a PythonPackageDistributionResource to the resources collection.

fn add_python_extension_module( &mut self, extension_module: &PythonExtensionModule, add_context: Option<PythonResourceAddCollectionContext>, ) -> Result<Vec<AddResourceAction>>

Add a PythonExtensionModule to make available.

fn add_file_data( &mut self, file: &File, add_context: Option<PythonResourceAddCollectionContext>, ) -> Result<Vec<AddResourceAction>>

Add a File to the resource collection.

fn filter_resources_from_files( &mut self, files: &[&Path], glob_patterns: &[&str], ) -> Result<()>

Filter embedded resources against names in files.

fn requires_jemalloc(&self) -> bool

Whether the binary requires the jemalloc library.

fn requires_mimalloc(&self) -> bool

Whether the binary requires the Mimalloc library.

fn requires_snmalloc(&self) -> bool

Whether the binary requires the Snmalloc library.

fn licensed_components(&self) -> Result<LicensedComponents>

Obtain software licensing information.

fn add_licensed_component(&mut self, component: LicensedComponent) -> Result<()>

Add a licensed software component to the instance.

fn to_embedded_python_context( &self, env: &Environment, opt_level: &str, ) -> Result<EmbeddedPythonContext<'_>>

Obtain an EmbeddedPythonContext instance from this one.