Run Python Code

Run Python statements or script files in the Live Editor

Since R2024a

expand all in page

Description

The Run Python Code task lets you interactively run Python® code or files. The task automatically generates MATLAB® code for your live script. For more information about Live Editor tasks generally, see Add Interactive Tasks to a Live Script.

Using this task, you can:

  • Write and execute Python code.

  • Execute code in Python files.

  • Return Python variables to the MATLAB workspace.

  • Pass MATLAB data to the Python code.

  • Specify command-line arguments.

Run Python statements or script files in the Live Editor

Open the Task

To add the Run Python Code task to a live script in the MATLAB Editor:

  • On the Live Editor tab, select Task > Run Python Code.

  • In a code block in the script, type a relevant keyword, such as Python or run. Select Run Python Code from the suggested command completions.

Examples

expand all

Interactively run Python code using the Run Python Code task in the Live Editor. Variables created with the Run Python Code task are persistent. You can refer to these variables in subsequent Run Python Code tasks.

Create MATLAB variables a and b.

a = 3;
b = 4;

Open the Run Python Code task in the Live Editor, and select Code as the input type. Type the following Python code in the Enter Python code section. The Python math.sqrt function uses the MATLAB variables a and b as inputs. In the Output options section, select Return all to return all the generated Python variables to the MATLAB workspace, and select the Display outputs check box to display the values of the variables as task output. Then click the Run button.

import math

h = math.sqrt(a**2 + b**2)

Run Python Code Live Editor task with parameters described in the example

If you add subsequent Run Python Code tasks to the live script, they use the values of a, b, and h from this Run Python Code task and continue to use the previously imported Python math library.

Run Python code in a Python file in MATLAB, and return some of the generated Python variables to the MATLAB workspace.

Create a Python file named circumference.py from the following statements. This Python code calculates the circumference, c, of a circle using the radius, r.

import math 
r = 5
c = 2 * math.pi * r

Open the Run Python Code task in the Live Editor, and select File as the input type. Then, specify the path to circumference.py in the Select Python file section.

By default, the Live Editor task returns all the generated Python variables to the MATLAB workspace. Return only c by selecting Return selected variables and moving c from the Generated Python variables list to the Output list. Select the Display outputs check box to see the value of c in MATLAB. Then click the Run button.

Run Python Code Live Editor task with parameters described in the example

Run Python code in a Python file in MATLAB with command-line arguments.

Create a Python file named calculator.py from the following statements. This Python code takes two integer inputs, x and y, from the user on the command line. The code subtracts x and y and stores the difference in diff and then multiplies x and y and stores the product in prod.

import sys

arg_list = list()

for arg in sys.argv:
  arg_list.append(arg)

if len(sys.argv) < 2:
  print("Initialize x and y using integers as command-line arguments.")
  exit()

x = int(arg_list[1])
y = int(arg_list[2])

diff = x - y
prod = x * y

Open the Run Python Code task in the Live Editor, and select File as the input type. Then, specify the path to calculator.py in the Select Python file section.

In the Specify command line arguments section, specify command-line arguments 5 and 6 by using the + button to add arguments. The argument specified at the top of the list is arg_list[1], or in this case, 5, and the argument next in the list is arg_list[2], or in this case, 6. Select the Display outputs check box to see the values of the Python variables in the MATLAB workspace. Then click the Run button.

Run Python Code Live Editor task with parameters described in the example

Related Examples

Parameters

expand all

This task operates on the specified type of Python code:

  • Code ― Type Python statements in the text box in the Enter Python code section.

  • File ― Specify the path to a Python file in the Select Python file section.

You can pass a MATLAB workspace variable to Python code in the task using these methods:

  • Assign the MATLAB variable to a Python variable in the task.

  • Pass the MATLAB variable to a Python function in the task.

  • Use the MATLAB variable as an operand in a Python operation in the task.

When you select Code as the input type:

  • Python variables you create are persistent. You can refer to the Python variables in subsequent Run Python Code tasks that also use Code as the input type. Variables are persistent because the Run Python Code task utilizes pyrun.

  • Python variables you create in the task take precedence over a MATLAB variable with the same name created later in the code. In other words, the Run Python Code task does not use the variable in the MATLAB workspace.

  • If you import a Python library, then you do not need to import the same library in subsequent tasks.

If you select the input type as File, you can specify command-line arguments. These arguments are useful for passing inputs to the specified Python file. Type one argument in each Argument box. Click the + button to add more command-line arguments and the – button to remove command-line arguments from the list. You can reorder the arguments using the up and down triangle buttons.

Specify which generated Python variables you want the Live Editor task to return to the MATLAB workspace:

  • Return all ― Return all the variables that MATLAB detects in the Python code to the MATLAB workspace.

  • Return selected variables ― Return only the variables in the Output list. Move variables to the Output list by selecting them in the Generated Python variables list and then clicking the right-arrow button.

This option controls whether to display the selected Python variables as task output.

Limitations

  • Python classes defined using pyrun or pyrunfile cannot be modified if you return an instance of the class to MATLAB. If you need to change class definitions, restart the interpreter session:

    terminate(pyenv)
pyenv(ExecutionMode="OutOfProcess")

    Alternatively, restart MATLAB for "InProcess".

    The pyrun and pyrunfile functions do not support classes with local variables that are initialized by other local variables through methods. For such usage, create a module and access it using the py. prefix.

  • Type conversion based on Python type hints is not supported for pyrun, pyrunfile or the Run Python Code task where native Python code is provided as input.

Version History

Introduced in R2024a

See Also

Functions