UI Bakery Docs
RoadmapRelease notesSign In
  • 👋Welcome to UI Bakery!
  • 🌟Overview
    • 💡Video intro
    • ✨Main features
    • 🔖Glossary
  • 🛠️Getting started
    • Create an application
    • Build UI
      • Data mocking methods
    • Link components
    • Connect a data source
    • Load data
    • Bind data to UI
    • Transform data with JavaScript
      • Data mapping & transforming
    • Change component data
    • Send a form
    • Create a filter
    • Note on debugging
    • Deploy your application & invite users
  • 📌Concepts
    • Components
      • Component basics
      • Component methods
      • Components best practices
        • Input validation
        • Linking a Table to a Form/Detail
        • Using a single Form to add and update data
        • Searching Table based on input value
        • Configuring server-side pagination
        • Managing Date object time zones
        • Role-based Menu component items
        • Field types & types recognition
          • Select/Tag field: Utilizing Tag mapper
        • Expanding component to fit screen/container
        • Controlling component's visibility
    • Custom components
      • Unrestricted custom components
    • Data sources
      • Data source environments
      • Connecting local database via ngrok
      • SSH Tunneling
    • Actions
      • Actions basics
        • Calling actions from code
      • Actions management & shortcuts
      • Actions settings
      • Actions library
      • Server actions
      • Logs and debugging
    • UI Bakery variables
    • State variables
    • Local storage
    • Modules
    • Custom JavaScript
      • JavaScript files
    • Workspace management
      • Account & workspace
      • Seats & Shared permission groups in UI Bakery
      • Roles in UI Bakery
      • Role permissions
      • Explore the interface
      • App environments
        • Release management
      • Audit logs
      • Multi-factor authentication
    • Export & import an app
    • Mobile layout
    • Theme editor
      • Changing theme from the app
    • UI Bakery source control
      • Git controls overview
      • Migrating your app model to the latest version
  • ⚡How-tos
    • File management
      • Working with PDF files
      • CSV import & export
      • Uploading files using methods
      • Displaying files from Google Drive and Dropbox
      • Parsing and sending XML
    • Styling
      • Modifying components with CSS
    • Layout & navigation
      • Adding navigation to application
      • Reading query params from URL
      • Hiding UI Bakery loader in the Embedded mode
    • Data
      • Managing user data with the {{user.email}} variable
      • Using JS libraries
        • Internationalization (i18n) & Localization: Translating UI Bakery Apps
      • Implementing row-level security
      • Copying to clipboard
    • Custom code
      • Communicating with external sites via Iframe
      • Implementing custom app hotkeys
      • Retrying API with HTTP status code 202
  • 🔎Extras
    • UI Bakery Automations
      • Environment and release strategy
      • Git in automations
      • Using external Node libraries
    • UI Bakery Database
      • Database migration
  • 💻On-premise
    • UI Bakery on-premise
    • Install & update
      • Installing on-premise
        • Azure virtual machine
        • Azure container instance
        • AWS EC2 instance
        • Google Cloud Compute Engine VM instance
        • DigitalOcean 1-click droplet
        • Manual w/ docker compose
        • Manual w/ docker run
        • Windows installation
        • Kubernetes
          • AWS EKS with Fargate
          • Scaling and resource optimization
      • Troubleshooting installation errors
      • Updating on-premise
      • Updating license key
      • Updating environment variables
      • Recommendations
        • Architecture overview
        • UI Bakery in production
        • Resource optimization
        • Running a standalone database instance
        • Generating custom secrets
    • On-premise features
      • External analytics
      • Branding
      • Embedding
      • SCIM 2.0
      • Instance API
      • Activating features under a feature flag
    • Additional configurations
      • Health check API
      • Email configuration
      • Google Sheets connection setup
      • Salesforce connection setup
      • Azure blob storage configuration
      • Adding python backend code to existing installation
      • UI Bakery Postgres
    • Networking & security
      • Setting up a domain name
      • Configuring custom certificate authority
      • Custom base URL
      • Getting requests to the local network
      • Setting up SSL on Ubuntu
    • SSO
      • OpenID
        • Google OAuth2
        • Okta ODIC
        • Azure AD OAuth2
        • Token refresh
      • SAML
        • Okta SAML
        • Azure AD SAML
      • Role synchronization
      • Multiple SSO
      • Logout redirect
      • Troubleshooting
    • Git source control
      • Manage multi-instance deployment
      • Custom PR URL
      • Automate GitHub releases
      • Automate GitLab releases
      • Automate Bitbucket releases
    • Environment variables
  • 📚Reference
    • Data security measures
    • Improving app security
    • ✨AI Assistant
    • List of Components
      • Azure Blob Storage file uploader
      • Accordion
      • Alert
      • Avatar
      • Boolean
      • Breadcrumbs
      • Bubble map
      • Button
      • Card
      • Chart
      • Chat
      • Checkbox
      • Collapsible card
      • Color picker
      • Composite form
      • Container
      • Context menu button
      • Currency
      • Currency input
      • Date picker
      • Date & time
      • Date & time picker
      • Detail
      • Divider
      • Email input
      • Embedded App
      • File
      • File dropzone
      • File picker
      • Flex container
      • Form
      • Frame drawer
      • Grid view
      • Heading
      • Horizontal menu
      • Icon
      • iFrame
      • Image
      • Image picker
      • JSON editor
      • JSON viewer
      • Link
      • List view
      • Map
      • Menu
      • Metric
      • Modal
      • Multi-select
      • Number
      • Number input
      • Password input
      • PDF viewer
      • Percent
      • Pop-up form
      • Progress bar
      • QR code
      • Radio
      • Range slider
      • Rating
      • Reusable header
      • Reusable sidebar
      • Select
      • Signature
      • Slider
      • Steps
      • Stepper
      • S3 file uploader
      • Table
        • Conditional formatting based on cell value
        • Display name instead of ID for relation
        • Row context referencing
        • Select multiple table rows
        • How to Highlight Text in a Table Using mark.js
      • Tabs
      • Tabset
      • Tags
      • Text
      • Text annotate
      • Text input
      • Time picker
      • Toggle
      • Tree component
      • Video
      • Dynamic structure properties
      • Card (deprecated)
      • Input (deprecated)
    • Upgrading components
    • List of Data sources
      • Airtable
      • AWS API
      • AWS Athena
      • AWS DynamoDB
      • AWS Lambda
      • AWS Redshift
      • AWS S3
        • S3 compatible endpoints (DigitalOcean spaces)
      • Azure Blob Storage
      • Big Query
      • Databricks
      • Exasol
      • Firestore, Firebase Auth & Realtime DB
        • Firebase authentication
        • Managing database data
        • Firebase client-side SDK
        • Firebase libraries
      • GitHub
      • Google Sheets
      • GraphQL
      • HTTP API
        • API Authentication
      • HubSpot
      • JDBC
      • MariaDB
      • MongoDB
      • MySQL
      • OpenAI
      • OpenAPI
      • Oracle
      • PostgreSQL
      • Presto
      • Redis
      • Salesforce
      • SAP Hana
      • SendGrid
      • Slack
      • SMTP
      • Snowflake
      • Spanner
      • SSH
      • Stripe
      • SQL Server
      • Supabase
      • Twilio
      • UI Bakery AI
    • List of Action steps
      • AI Action
      • Azure Blob Storage Query
      • Bulk Create Rows
      • Bulk Delete Rows
      • Condition
      • Create Row
      • Delete Row
      • DynamoDB Request
      • Execute Action
      • Firebase Query
      • Generate File
      • GraphQL Query
      • HTTP Request
      • Interval
      • JavaScript Code
      • Load Table
      • Load Row
      • Loop Action
      • MongoDB Command
      • Navigate
      • Open API Request
      • Python Backend Code
      • Redis Command
      • Save to Local Storage
      • Save to State
      • Show Notification
      • Slack messages
      • SMTP Request
      • SSH Command
      • SQL Query
        • Writing SQL Queries
      • S3 Query
      • Update Row
    • Troubleshooting techniques
    • Performance optimization
Powered by GitBook

© 2025 UI Bakery

On this page

Was this helpful?

Export as PDF

Last updated 2 months ago

Was this helpful?

Using Python

The Python Code Step allows you to write Python code that will be run on the backend. The common use cases for the Python Step are transforming and mapping of the data, as well as execution of machine learning-related functions.

You can use a number of pre-installed libraries to utilize their functionality within your code:

Variables in the code

If you want to use app variables in the Python code step, you must add them to the Variables section and NOT use directly in the code.

There, you can pass values from UI components using {{ui.input.value}}. And you can also use some predefined variables to access the result of the previous step or to get user-related information.

While data and error are specific to a particular step, params is available in all steps.

Merging results of multiple steps

In some cases, you may need to merge the results of multiple steps into a single object. This must also be done using the Variables section - pass this information to Python and access the output of any previous step using {{steps.<step_name>.data}}.

Editor hotkeys

  • Ctrl + Enter/Cmd + Enter - run the action

  • Ctrl + F/Cmd + F - find in code

  • Ctrl + G/Cmd + G - next find result

  • Shift + Ctrl + F/Cmd + Option + F - find and replace in the query

  • Ctrl + L/Cmd + L - jump to line

  • Ctrl + Alt + L/Cmd + Option + L - format code

Import external modules

To import external libraries, such as NumPy or Pandas, you can use the import statement in your Python code. These libraries provide a wide range of useful functions and tools for data manipulation and analysis.

Here's an example of how to import NumPy:

Similarly, here's an example of how to import Pandas:

Data transformation

If the API returns its data in a different format than the components expect, you can use the Code Step to transform it. Python offers several built-in methods for transforming data, such as map(), filter(), and reduce(). For example, to add a new key to a list of dictionaries you can use the following code:

This creates a new list of dictionaries with an additional key is_adult that is True if the age key is greater than or equal to 18. You can also use functions from external libraries such as NumPy and Pandas for more complex transformations.

Debugging errors

In case the code is failing or produces unexpected results:

  • Make sure no linter errors are present in the code (exclamation mark in the left gutter);

  • Check the result of the previous step (the data variable) and of the other variables (for example, params);

  • Comment out the code and add return data to see if the data is in the expected format;

  • Use print to print the data to the console (Logs tab at the bottom of the action).

    abc,
    array,
    asyncio,
    azure-cosmos,
    base64,
    bs4,
    bson,
    builtins,
    collections,
    charset_normalizer,
    dateutil,
    errno,
    geopy,
    google.protobuf,
    gc,
    jinja2,
    jira,
    jwt,
    machine,
    math,
    matplotlib,
    music,
    neopixel,
    numpy,
    openai,
    packaging,
    pandas,
    power,
    pypdf,
    pytz,
    query7,
    radio,
    random,
    requests,
    rsa,
    scipy,
    seaborn,
    sklearn,
    speech,
    struct,
    tabulate,
    time,
    types,
    typeshed,
    typing,
    typing_extensions,
    uarray,
    ucollections,
    uerrno,
    urandom,
    ustructu,
    usys,
    utime,
    yaml,
    datetime,
    llama_index,
    tiktoken
# result of the previous step
return data

# error response of the previous step
return error

# incoming action params, passed in by components,
# the Execution/Loop action steps or when calling the action from the code
return params

# get roles of the current user
return user.get('roles')
import numpy as np

# Now you can use NumPy functions and tools in your code, for example:
my_array = np.array([1, 2, 3])
import pandas as pd

# Now you can use Pandas functions and tools in your code, for example:
my_dataframe = pd.DataFrame({'col1': [1, 2], 'col2': [3, 4]})
data = [{'name': 'Alice', 'age': 25}, {'name': 'Bob', 'age': 30}]
new_data = [{'name': d['name'], 'age': d['age'], 'is_adult': d['age'] >= 18} for d in data]
# commented to test
# if length(data) > 10:
#   return data
# 

print(data)
  1. 📚Reference
  2. List of Action steps

Python Backend Code

PreviousOpen API RequestNextRedis Command
  • Using Python
  • Variables in the code
  • Editor hotkeys
  • Import external modules
  • Data transformation
  • Debugging errors