Skip to main content

PythonModule

Struct PythonModule 

Source
pub struct PythonModule {
    pub imports: Vec<(String, Option<String>)>,
    pub from_imports: FromImports,
    pub classes: Vec<PythonClass>,
    pub functions: Vec<PythonFunction>,
    pub statements: Vec<PythonStmt>,
    pub module_docstring: Option<String>,
    pub all_exports: Vec<String>,
}
Expand description

A complete Python module (one .py file).

Fields§

§imports: Vec<(String, Option<String>)>

Module-level imports: import X or import X as Y

§from_imports: FromImports

From-imports: from X import Y or from X import Y as Z

§classes: Vec<PythonClass>

Top-level class definitions

§functions: Vec<PythonFunction>

Top-level function definitions

§statements: Vec<PythonStmt>

Other top-level statements

§module_docstring: Option<String>

Module docstring

§all_exports: Vec<String>

__all__ exports

Implementations§

Source§

impl PythonModule

Source

pub fn new() -> Self

Create a new empty Python module.

Source

pub fn add_import(&mut self, module: impl Into<String>, alias: Option<String>)

Add a module-level import.

Source

pub fn add_from_import( &mut self, module: impl Into<String>, names: Vec<(String, Option<String>)>, )

Add a from-import.

Source

pub fn add_class(&mut self, cls: PythonClass)

Add a class definition.

Source

pub fn add_function(&mut self, func: PythonFunction)

Add a function definition.

Source

pub fn add_statement(&mut self, stmt: PythonStmt)

Add a top-level statement.

Source

pub fn emit(&self) -> String

Emit the full Python module as a string.

Trait Implementations§

Source§

impl Clone for PythonModule

Source§

fn clone(&self) -> PythonModule

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 PythonModule

Source§

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

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

impl Default for PythonModule

Source§

fn default() -> Self

Returns the “default value” for a type. 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, 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.