Power Fx Python Bridge

Common errors

• RuntimeError: Can not determine dotnet root

  cause The `pythonnet` library, used by `powerfx` to bridge to the C# implementation, cannot locate the .NET runtime installation on your system.
  fix Install the .NET SDK or runtime for your operating system and architecture. If it's not installed in a default path, set the `DOTNET_ROOT` environment variable to the path where .NET is installed (e.g., `export DOTNET_ROOT=/usr/local/share/dotnet`).

• FileNotFoundException: Could not load file or assembly 'System.Runtime, Version=..., Culture=neutral, PublicKeyToken=...' or one of its dependencies.

  cause This typically indicates an incompatibility between the installed .NET runtime and the version of the `powerfx` library's C# components, or a corrupted .NET installation.
  fix Verify that your .NET runtime version is compatible with the `powerfx` library. Try updating your .NET runtime to the latest stable version or reinstalling it. Also, consider reinstalling `powerfx` and its dependencies (`pip uninstall powerfx pythonnet` then `pip install powerfx`).

Warnings

• breaking The `powerfx` library is a Python bridge to a C# implementation. Major updates to the underlying Power Fx language or the C# runtime it depends on may introduce breaking changes not directly reflected in the Python package versioning.
  Fix: Always check the official Microsoft Power Fx documentation and any related .NET/C# interop documentation for compatibility. Pin `powerfx` versions in production environments.
• gotcha Requires .NET Runtime: The `powerfx` Python package will not function without a compatible .NET runtime installed and correctly configured on the system. This is a common point of failure for users.
  Fix: Ensure the appropriate .NET SDK or runtime is installed for your operating system (e.g., via `sudo apt install dotnet-sdk-8.0` on Linux, or `brew install --cask dotnet-sdk` on macOS). Set the `DOTNET_ROOT` environment variable if the runtime is not in a standard location.
• gotcha Power Fx is a declarative, Excel-like language. Trying to use it with imperative Python programming paradigms or expecting direct object manipulation as in Python will lead to unexpected results. It's not a Pythonic library in its core logic.
  Fix: Familiarize yourself with Power Fx language concepts and syntax, which are distinct from Python. Use the `powerfx.Engine` for evaluating Power Fx expressions, not as a general-purpose Python utility library.

Install

• pip install powerfx Install with pip

Imports

• Engine

  from powerfx import Engine

  The `Engine` class is the primary entry point for evaluating Power Fx expressions.

Quickstart

This quickstart demonstrates how to initialize the `powerfx.Engine`, register Python objects as host objects, and evaluate Power Fx expressions. It includes an example of string concatenation and a conditional statement. Note the crucial importance of a correctly installed and discoverable .NET runtime for `powerfx` to function.

import os
from powerfx import Engine

# Ensure DOTNET_ROOT is set if .NET runtime is not in standard paths
# Example: os.environ['DOTNET_ROOT'] = '/usr/local/share/dotnet'

# Initialize the Power Fx engine
engine = Engine()

# Define variables that can be used in Power Fx expressions
engine.add_host_object('Name', 'Alice')
engine.add_host_object('Age', 30)

# Evaluate a simple Power Fx expression
expression = '"Hello " & Name & ", you are " & Text(Age) & " years old!"'
result = engine.eval(expression)

print(f"Power Fx Expression: {expression}")
print(f"Result: {result.to_string()}")

# Example with a conditional expression
conditional_expression = 'If(Age >= 18, "Adult", "Minor")'
conditional_result = engine.eval(conditional_expression)

print(f"\nPower Fx Conditional Expression: {conditional_expression}")
print(f"Conditional Result: {conditional_result.to_string()}")