Struct PythonProgram

Source

pub struct PythonProgram { /* private fields */ }

Expand description

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.

Implementations§

Source §

impl PythonProgram

Source

pub fn new() -> PythonProgram ⓘ

Creates a named temp file to store the generated python program

Examples found in repository ?

examples/save.rs (line 6)

1fn main() {
2    use pycall::MatPlotLib;
3    let mut test_map = std::collections::HashMap::new();
4    test_map.insert("hello".to_owned(), vec![56, 12, 65, 3, 21]);
5    test_map.insert("there".to_owned(), vec![6, 2, 5, 13, 1]);
6    let mut program = pycall::PythonProgram::new();
7    program
8        .define_variable("test_map", &test_map)
9        .write_line("print(test_map)");
10    program.save_as("saved.py");
11}

More examples

Hide additional examples

examples/main.rs (line 12)

1fn main() {
2    let handles = (
3        std::thread::spawn(|| pycall::plot!(&vec![0, 1, 2, 3, 2, 1, 0])),
4        std::thread::spawn(|| {
5            pycall::plot!(&vec![-3, -2, -1, 3, 4, 5, 6], &vec![0, 1, 2, 3, 2, 1, 0])
6        }),
7        std::thread::spawn(|| {
8            pycall::plot!(&vec![0, 1, 2, 3, 4, 5, 6], &vec![0, 1, 2, 3, 2, 1, 0], "+")
9        }),
10    );
11    use pycall::MatPlotLib;
12    let mut program = pycall::PythonProgram::new();
13    program
14        .import_pyplot_as_plt()
15        .plot_y(&vec![0, 1, 2, 3, 2, 1, 0])
16        .plot_xyargs(&vec![0, 1, 2, 3, 4, 5, 6], &vec![0, 1, 2, 3, 2, 1, 0], "+")
17        .show();
18    program.background_run();
19    handles.0.join();
20    handles.1.join();
21    handles.2.join();
22}

Source

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

Examples found in repository ?

examples/save.rs (line 10)

1fn main() {
2    use pycall::MatPlotLib;
3    let mut test_map = std::collections::HashMap::new();
4    test_map.insert("hello".to_owned(), vec![56, 12, 65, 3, 21]);
5    test_map.insert("there".to_owned(), vec![6, 2, 5, 13, 1]);
6    let mut program = pycall::PythonProgram::new();
7    program
8        .define_variable("test_map", &test_map)
9        .write_line("print(test_map)");
10    program.save_as("saved.py");
11}

Source

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

Runs the program using python3

Source

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.

Examples found in repository ?

examples/main.rs (line 18)

1fn main() {
2    let handles = (
3        std::thread::spawn(|| pycall::plot!(&vec![0, 1, 2, 3, 2, 1, 0])),
4        std::thread::spawn(|| {
5            pycall::plot!(&vec![-3, -2, -1, 3, 4, 5, 6], &vec![0, 1, 2, 3, 2, 1, 0])
6        }),
7        std::thread::spawn(|| {
8            pycall::plot!(&vec![0, 1, 2, 3, 4, 5, 6], &vec![0, 1, 2, 3, 2, 1, 0], "+")
9        }),
10    );
11    use pycall::MatPlotLib;
12    let mut program = pycall::PythonProgram::new();
13    program
14        .import_pyplot_as_plt()
15        .plot_y(&vec![0, 1, 2, 3, 2, 1, 0])
16        .plot_xyargs(&vec![0, 1, 2, 3, 4, 5, 6], &vec![0, 1, 2, 3, 2, 1, 0], "+")
17        .show();
18    program.background_run();
19    handles.0.join();
20    handles.1.join();
21    handles.2.join();
22}

Source

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

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

Source

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

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

Source

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.

Source

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

Examples found in repository ?

examples/save.rs (line 8)

1fn main() {
2    use pycall::MatPlotLib;
3    let mut test_map = std::collections::HashMap::new();
4    test_map.insert("hello".to_owned(), vec![56, 12, 65, 3, 21]);
5    test_map.insert("there".to_owned(), vec![6, 2, 5, 13, 1]);
6    let mut program = pycall::PythonProgram::new();
7    program
8        .define_variable("test_map", &test_map)
9        .write_line("print(test_map)");
10    program.save_as("saved.py");
11}

Source

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

Writes an import statement for your dependency

Source

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

Writes an import statement for your dependency as rename

Source

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

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

Examples found in repository ?

examples/save.rs (line 9)

1fn main() {
2    use pycall::MatPlotLib;
3    let mut test_map = std::collections::HashMap::new();
4    test_map.insert("hello".to_owned(), vec![56, 12, 65, 3, 21]);
5    test_map.insert("there".to_owned(), vec![6, 2, 5, 13, 1]);
6    let mut program = pycall::PythonProgram::new();
7    program
8        .define_variable("test_map", &test_map)
9        .write_line("print(test_map)");
10    program.save_as("saved.py");
11}