Using Python in Query Editor

Is this page helpful?

You can use Python, a programming language widely used by statisticians, data scientists, and data analysts, in the Power BI Desktop Query Editor. This integration of Python into Query Editor lets you perform data cleansing using Python, and perform advanced data shaping and analytics in datasets, including completion of missing data, predictions, and clustering, just to name a few. Python is a powerful language, and can be used in Query Editor to prepare your data model and create reports.

Installing Python

To use Python in Power BI Desktop's Query Editor, you need to install Python on your local machine. You can download and install Python for free from many locations, including the Official Python download page, and the Anaconda.

Using Python in Query Editor

To show how to use Python in Query Editor, take this example from a stock market dataset, based on a .CSV file that you can download from here and follow along. The steps for this example are the following:

  1. First, load your data into Power BI Desktop. In this example, load the EuStockMarkets_NA.csv file and select Get Data > CSV from the Home ribbon in Power BI Desktop.

  2. Select the file and select Open, and the CSV is displayed in the CSV file dialog.

  3. Once the data is loaded, you'll see it in the Fields pane in Power BI Desktop.

  4. Open Query Editor by selecting Edit Queries from the Home tab in Power BI Desktop.

  5. In the Transform tab, select Run Python Script and the Run Python Script editor appears (shown in the next step). Notice that rows 15 and 20 suffer from missing data, as do other rows you can't see in the following image. The steps below show how Python can (and will) complete those rows for you.

  6. For this example, enter the following script code:

       import pandas as pd
       completedData = dataset.fillna(method='backfill', inplace=False)
       dataset["completedValues"] =  completedData["SMI missing values"]
    

    Note

    You'll need to have the pandas library installed in your Python environment for the previous script code to work properly. To install pandas, run the following command in your Python installation: | > pip install pandas

    When put into the Run Python Script dialog, the code looks like the following:

  7. After selecting OK, Query Editor displays a warning about data privacy.

  8. For the Python scripts to work properly in the Power BI service, all data sources need to be set to public. For more information about privacy settings and their implications, see Privacy Levels.

    Notice a new column in the Fields pane called completedValues. Notice there are a few missing data elements, such as on row 15 and 18. Take a look at how Python handles that in the next section.

With just five lines of Python script, Query Editor filled in the missing values with a predictive model.

Creating visuals from Python script data

Now we can create a visual to see how the Python script code using the pandas library completed the missing values, as shown in the following image:

Once that visual is complete, and any other visuals you might want to create using Power BI Desktop, you can save the Power BI Desktop file (which saves as a .pbix file) and then use the data model, including the Python scripts that are part of it, in the Power BI service.

Note

Want to see a completed .pbix file with these steps completed? You're in luck - you can download the completed Power BI Desktop file used in these examples right here.

Once you've uploaded the .pbix file to the Power BI service, a couple more steps are necessary to enable data refresh (in the service) and to enable visuals to be updated in the service (the data needs access to Python for visuals to be updated). The additional steps are the following:

  • Enable scheduled refresh for the dataset - to enable scheduled refresh for the workbook that contains your dataset with Python scripts, see Configuring scheduled refresh, which also includes information about Personal Gateway.
  • Install the Personal Gateway - you need a Personal Gateway installed on the machine where the file is located, and where Python is installed; the Power BI service must access that workbook and re-render any updated visuals. You can get more information on how to install and configure Personal Gateway.

Limitations

There are some limitations to queries that include Python scripts created in Query Editor:

  • All Python data source settings must be set to Public, and all other steps in a query created in Query Editor must also be public. To get to data source settings, in Power BI Desktop select File > Options and settings > Data source settings.

    From the Data Source Settings dialog, select the data source(s) and then select Edit Permissions... and ensure that the Privacy Level is set to Public.

  • To enable scheduled refresh of your Python visuals or dataset, you need to enable Scheduled refresh and have a Personal Gateway installed on the computer that houses the workbook and the Python installation. For more information on both, see the previous section in this article, which provides links to learn more about each.

  • Nested tables (table of tables) are currently not supported

There are all sorts of things you can do with Python and custom queries, so explore and shape your data just the way you want it to appear.