Supabase Functions Python Client (Deprecated)

Warnings

• breaking The `supafunc` package is officially deprecated as of August 8, 2025, in favor of `supabase_functions`. Version `0.10.2` is the last to receive updates and will issue deprecation warnings upon import. Future development and bug fixes will only be applied to `supabase_functions`.
  Fix: Migrate all package references (e.g., in `pyproject.toml`, `requirements.txt`) from `supafunc` to `supabase_functions` and update all import statements (e.g., `from supafunc import ...` to `from supabase_functions import ...`).
• breaking The minimum required Python version was bumped to 3.9 in `v0.6.2`. Users on older Python versions will encounter compatibility issues.
  Fix: Upgrade your Python environment to version 3.9 or higher.
• breaking In `v0.9.0`, region enumerated literals were rewritten as Python Enums. If your code relied on specific string values or direct comparisons with previous literal representations, this could be a breaking change.
  Fix: Update your code to use the new `Region` Enum members (e.g., `Region.US_EAST_1`) instead of string literals, if applicable.
• gotcha Prior to `v0.10.1`, strict JWT key validation might have caused issues with newer Supabase API keys. This was resolved by relaxing the validation.
  Fix: Upgrade to `v0.10.1` or `supabase_functions` to ensure compatibility with all API key types. If using an older version, ensure your API key is compatible with the stricter validation.
• gotcha Versions prior to `v0.9.3` improperly handled non-JSON body types when invoking functions, potentially leading to incorrect data transmission or errors.
  Fix: Upgrade to `v0.9.3` or `supabase_functions` if you are sending non-JSON payloads to your Edge Functions.

Install

• pip install supafunc Deprecated (use supabase_functions instead)
• pip install supabase_functions Recommended replacement

Imports

• AsyncFunctionsClient

  from supabase_functions import AsyncFunctionsClient

  The `supafunc` package is deprecated. Use `supabase_functions` for new projects and migrate existing ones.
• FunctionsClient

  from supabase_functions import FunctionsClient

  The `supafunc` package is deprecated. Use `supabase_functions` for new projects and migrate existing ones.

Quickstart

This example demonstrates how to invoke a Supabase Edge Function using the recommended `supabase-py` client, which includes the `supabase_functions` client for invoking functions. It assumes an Edge Function named 'hello-world' is deployed on your Supabase project. Replace placeholder environment variables with your actual Supabase project URL and Anon Key.

import os
from supabase import create_client

# Note: This quickstart uses the recommended 'supabase_functions' client
# Ensure your Supabase project URL and Anon Key are set as environment variables
SUPABASE_URL = os.environ.get('SUPABASE_URL', 'YOUR_SUPABASE_URL')
SUPABASE_ANON_KEY = os.environ.get('SUPABASE_ANON_KEY', 'YOUR_SUPABASE_ANON_KEY')

# Initialize the Supabase client, which includes the functions client
supabase = create_client(SUPABASE_URL, SUPABASE_ANON_KEY)
functions_client = supabase.functions

async def invoke_hello_world():
    try:
        # Assuming you have an Edge Function named 'hello-world' deployed
        # that expects a JSON body like {'name': 'World'}
        response = await functions_client.invoke(
            'hello-world',
            invoke_options={'body': {'name': 'Supabase User'}}
        )
        print(f"Function invoked successfully: {response.data}")
    except Exception as e:
        print(f"Error invoking function: {e}")

if __name__ == '__main__':
    import asyncio
    asyncio.run(invoke_hello_world())