Skip to main content

PythonConfig

Struct PythonConfig 

Source
pub struct PythonConfig {
Show 15 fields pub module_name: Option<String>, pub async_runtime: Option<String>, pub stubs: Option<StubsConfig>, pub pip_name: Option<String>, pub features: Option<Vec<String>>, pub serde_rename_all: Option<String>, pub capsule_types: HashMap<String, String>, pub release_gil: bool, pub exclude_functions: Vec<String>, pub exclude_types: Vec<String>, pub extra_dependencies: HashMap<String, Value>, pub scaffold_output: Option<PathBuf>, pub rename_fields: HashMap<String, String>, pub run_wrapper: Option<String>, pub extra_lint_paths: Vec<String>,
}

Fields§

§module_name: Option<String>§async_runtime: Option<String>§stubs: Option<StubsConfig>§pip_name: Option<String>

PyPI package name (e.g. "html-to-markdown"). Used as the [project] name in pyproject.toml and to derive the python-packages list for maturin. Defaults to the crate name.

§features: Option<Vec<String>>

Per-language feature override. When set, these features are used instead of [crate] features for this language’s binding crate.

§serde_rename_all: Option<String>

Override the serde rename_all strategy for JSON field names (e.g. “camelCase”, “snake_case”). When set, this takes priority over the IR type-level serde_rename_all.

§capsule_types: HashMap<String, String>

Map of type name -> PyCapsule name for raw pointer wrapping. When a function returns one of these types, alef generates PyCapsule_New instead of Arc wrapping.

§release_gil: bool

When true, wrap blocking function bodies in py.allow_threads() to release the GIL.

§exclude_functions: Vec<String>

Functions to exclude from Python binding generation.

§exclude_types: Vec<String>

Types to exclude from Python binding generation.

§extra_dependencies: HashMap<String, Value>

Additional Cargo dependencies for this language’s binding crate only.

§scaffold_output: Option<PathBuf>

Override the scaffold output directory for this language’s Cargo.toml and package files.

§rename_fields: HashMap<String, String>

Per-field name remapping for this language. Key is TypeName.field_name (e.g. "LayoutDetection.class"), value is the desired binding field name. Applied after automatic keyword escaping, so an explicit entry takes priority.

§run_wrapper: Option<String>

Prefix wrapper for default tool invocations. When set, prepends this string to default commands across all pipelines (lint, test, build, etc.). E.g., run_wrapper = "uv run --no-sync" turns ruff format packages/python into uv run --no-sync ruff format packages/python.

§extra_lint_paths: Vec<String>

Extra paths to append to default lint commands (format, check, typecheck). Space-separated paths are appended to the command.

Trait Implementations§

Source§

impl Clone for PythonConfig

Source§

fn clone(&self) -> PythonConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PythonConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for PythonConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PythonConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,