Struct pycall::PythonProgram

pub struct PythonProgram { /* fields omitted */ }

An instance of code generation unit. It really is just a file with dedicated APIs to write Python into it. Most importantly: it manages indentation for you.

Methods

impl PythonProgram

Important traits for PythonProgram

impl Write for PythonProgram

pub fn new() -> PythonProgram

Creates a named temp file to store the generated python program

pub fn save_as<P: AsRef<Path>>(&self, path: P) -> Result<u64, Error>

pub fn run(&self) -> Result<Output, Error>

Runs the program using python3

pub fn background_run(self) -> JoinGuard<Result<Output, Error>>

Spawns a thread to run the program using python3. The returned JoinGuard ensures that the program will be ran to completion.

pub fn flush(&mut self) -> &mut Self

Ensures that the internal file has been flushed. Typically not necessary.

pub fn indent(&mut self, n: isize) -> &mut Self

Moves the indentation level by n. However, I recommend using the dedicated functions when possible/

pub fn end_block(&mut self) -> &mut Self

Removes one indentation level from the cursor. You should call this whenever you're done with a scope.

pub fn define_variable<T: AsPythonLitteral + ?Sized>(
    &mut self,
    name: &str,
    value: &T
) -> &mut Self

Writes a line assigning value formatted as a python literal to name

pub fn import(&mut self, dependency: &str) -> &mut Self

Writes an import statement for your dependency

pub fn import_as(&mut self, dependency: &str, rename: &str) -> &mut Self

Writes an import statement for your dependency as rename

pub fn write_line(&mut self, line: &str) -> &mut Self

Writes whatever line you passed it, indented at the proper level.

pub fn if(&mut self, condition: &str) -> &mut Self

Writes an if, using your condition as a test, and increments indentation.

pub fn elif(&mut self, condition: &str) -> &mut Self

Decrements indentation, writes an elif, using your condition as a test, and increments indentation.

pub fn else(&mut self) -> &mut Self

Decrements indentation, writes an else, using your condition as a test, and increments indentation.

pub fn for(&mut self, range: &str) -> &mut Self

Writes "for range:", and increments indentation.

pub fn while(&mut self, condition: &str) -> &mut Self

Writes a while, using your condition as a test, and increments indentation.

Trait Implementations

impl Display for PythonProgram

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

Formats the value using the given formatter.

impl MatPlotLib for PythonProgram

fn import_pyplot_as_plt(&mut self) -> &mut Self

fn plot_y<Y: AsPythonLitteral>(&mut self, y: &Y) -> &mut Self

fn plot_xy<X: AsPythonLitteral, Y: AsPythonLitteral>(
    &mut self,
    x: &X,
    y: &Y
) -> &mut Self

fn plot_xyargs<X: AsPythonLitteral, Y: AsPythonLitteral>(
    &mut self,
    x: &X,
    y: &Y,
    args: &str
) -> &mut Self

fn semilogy_y<Y: AsPythonLitteral>(&mut self, y: &Y) -> &mut Self

fn semilogy_xy<X: AsPythonLitteral, Y: AsPythonLitteral>(
    &mut self,
    x: &X,
    y: &Y
) -> &mut Self

fn semilogy_xyargs<X: AsPythonLitteral, Y: AsPythonLitteral>(
    &mut self,
    x: &X,
    y: &Y,
    args: &str
) -> &mut Self

fn show(&mut self) -> &mut Self

impl Write for PythonProgram

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<(), Error>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.