supabase-py API reference

62 public APIs from supabase-py (supabase/supabase-py) — 27 classes, 1 functions, 34 methods. Signatures extracted by static analysis of the actual source.

Repository: supabase/supabase-py

Kind	Count
Classes	27
Functions	1
Methods	34

API list

method

src.auth.src.supabase_auth._async.gotrue_mfa_api.AsyncGoTrueMFAAPI.unenroll(params:MFAUnenrollParams) -> AuthMFAUnenrollResponse

Unenroll removes a MFA factor.

method

src.auth.src.supabase_auth._sync.gotrue_mfa_api.SyncGoTrueMFAAPI.unenroll(params:MFAUnenrollParams) -> AuthMFAUnenrollResponse

Unenroll removes a MFA factor.

funcsrc.auth.src.supabase_auth.helpers.generate_pkce_challenge(code_verifier) -> str

Generate a code challenge from a PKCE verifier.

classsrc.auth.src.supabase_auth.types.AMREntry

An authentication methord reference (AMR) entry.

classsrc.auth.src.supabase_auth.types.CreateOAuthClientParams

Parameters for creating a new OAuth client.

classsrc.auth.src.supabase_auth.types.Factor

A MFA factor.

classsrc.auth.src.supabase_auth.types.GenerateLinkProperties

The properties related to the email link generated.

classsrc.auth.src.supabase_auth.types.OAuthClient

OAuth client object returned from the OAuth 2.1 server.

classsrc.auth.src.supabase_auth.types.OAuthClientListResponse

Response type for listing OAuth clients.

classsrc.auth.src.supabase_auth.types.OAuthClientResponse

Response type for OAuth client operations.

classsrc.auth.src.supabase_auth.types.PageParams

Pagination parameters.

classsrc.auth.src.supabase_auth.types.Pagination

Pagination information for list responses.

classsrc.auth.src.supabase_auth.types.UpdateOAuthClientParams

Parameters for updating an existing OAuth client.

classsrc.functions.src.supabase_functions.errors.FunctionsRelayError

Base exception for relay errors.

classsrc.postgrest.src.postgrest._async.client.AsyncPostgrestClient

PostgREST client.

methodsrc.postgrest.src.postgrest._async.client.AsyncPostgrestClient.aclose() -> None

Close the underlying HTTP connections.

methodsrc.postgrest.src.postgrest._async.client.AsyncPostgrestClient.from_(table:str) -> AsyncRequestBuilder

Perform a table operation.

methodsrc.postgrest.src.postgrest._async.client.AsyncPostgrestClient.from_table(table:str) -> AsyncRequestBuilder

Alias to :meth:`from_`.

methodsrc.postgrest.src.postgrest._async.client.AsyncPostgrestClient.schema(schema:str) -> AsyncPostgrestClient

Switch to another schema.

methodsrc.postgrest.src.postgrest._async.client.AsyncPostgrestClient.table(table:str) -> AsyncRequestBuilder

Alias to :meth:`from_`.

classsrc.postgrest.src.postgrest._sync.client.SyncPostgrestClient

PostgREST client.

methodsrc.postgrest.src.postgrest._sync.client.SyncPostgrestClient.aclose() -> None

Close the underlying HTTP connections.

methodsrc.postgrest.src.postgrest._sync.client.SyncPostgrestClient.from_(table:str) -> SyncRequestBuilder

Perform a table operation.

methodsrc.postgrest.src.postgrest._sync.client.SyncPostgrestClient.from_table(table:str) -> SyncRequestBuilder

Alias to :meth:`from_`.

method

src.postgrest.src.postgrest._sync.client.SyncPostgrestClient.rpc(func:str, params:dict[str, str], count:Optional[CountMethod]=None, head:bool=False, get:bool=False) -> SyncRPCFilterRequestBuilder

Perform a stored procedure call.

methodsrc.postgrest.src.postgrest._sync.client.SyncPostgrestClient.schema(schema:str) -> SyncPostgrestClient

Switch to another schema.

methodsrc.postgrest.src.postgrest._sync.client.SyncPostgrestClient.table(table:str) -> SyncRequestBuilder

Alias to :meth:`from_`.

classsrc.postgrest.src.postgrest.base_client.BasePostgrestClient

Base PostgREST client.

classsrc.postgrest.src.postgrest.exceptions.APIError

Base exception for all API errors.

methodsrc.postgrest.src.postgrest.exceptions.APIError.json() -> Dict[str, str]

Convert the error into a dictionary.

classsrc.realtime.src.realtime.message.Message

Dataclass abstraction for message

classsrc.storage.src.storage3._async.client.AsyncStorageClient

Manage storage buckets and files.

methodsrc.storage.src.storage3._async.client.AsyncStorageClient.from_(id:str) -> AsyncBucketProxy

Run a storage file operation.

classsrc.storage.src.storage3._async.file_api.AsyncBucket

Represents a storage bucket.

classsrc.storage.src.storage3._async.file_api.AsyncBucketActionsMixin

Functions needed to access the file API.

method

src.storage.src.storage3._async.file_api.AsyncBucketActionsMixin.create_signed_upload_url(path:str, options:Optional[CreateSignedUploadUrlOptions]=None) -> SignedUploadURL

Creates a signed upload URL.

method

src.storage.src.storage3._async.file_api.AsyncBucketActionsMixin.download(path:str, options:Optional[DownloadOptions]=None, query_params:Optional[Dict[str, str]]=None) -> bytes

Downloads a file.

methodsrc.storage.src.storage3._async.file_api.AsyncBucketActionsMixin.exists(path:str) -> bool

Returns True if the file exists, False otherwise.

methodsrc.storage.src.storage3._async.file_api.AsyncBucketActionsMixin.info(path:str) -> dict[str, Any]

Lists info for a particular file.

method

src.storage.src.storage3._async.file_api.AsyncBucketActionsMixin.list(path:Optional[str]=None, options:Optional[ListBucketFilesOptions]=None) -> list[dict[str, Any]]

Lists all the files within a bucket.

classsrc.storage.src.storage3._sync.client.SyncStorageClient

Manage storage buckets and files.

methodsrc.storage.src.storage3._sync.client.SyncStorageClient.from_(id:str) -> SyncBucketProxy

Run a storage file operation.

classsrc.storage.src.storage3._sync.file_api.SyncBucket

Represents a storage bucket.

classsrc.storage.src.storage3._sync.file_api.SyncBucketActionsMixin

Functions needed to access the file API.

method

src.storage.src.storage3._sync.file_api.SyncBucketActionsMixin.create_signed_upload_url(path:str, options:Optional[CreateSignedUploadUrlOptions]=None) -> SignedUploadURL

Creates a signed upload URL.

method

src.storage.src.storage3._sync.file_api.SyncBucketActionsMixin.download(path:str, options:Optional[DownloadOptions]=None, query_params:Optional[Dict[str, str]]=None) -> bytes

Downloads a file.

methodsrc.storage.src.storage3._sync.file_api.SyncBucketActionsMixin.exists(path:str) -> bool

Returns True if the file exists, False otherwise.

methodsrc.storage.src.storage3._sync.file_api.SyncBucketActionsMixin.info(path:str) -> dict[str, Any]

Lists info for a particular file.

method

src.storage.src.storage3._sync.file_api.SyncBucketActionsMixin.list(path:Optional[str]=None, options:Optional[ListBucketFilesOptions]=None) -> list[dict[str, Any]]

Lists all the files within a bucket.

classsrc.storage.src.storage3.types.BaseBucket

Represents a file storage bucket.

classsrc.storage.src.storage3.utils.StorageException

Error raised when an operation on the storage API fails.

classsrc.supabase.src.supabase._async.client.AsyncClient

Supabase client class.

methodsrc.supabase.src.supabase._async.client.AsyncClient.from_(table_name:str) -> AsyncRequestBuilder

Perform a table operation.

methodsrc.supabase.src.supabase._async.client.AsyncClient.get_channels() -> List[AsyncRealtimeChannel]

Returns all realtime channels.

methodsrc.supabase.src.supabase._async.client.AsyncClient.table(table_name:str) -> AsyncRequestBuilder

Perform a table operation.

classsrc.supabase.src.supabase._sync.auth_client.SyncSupabaseAuthClient

Supabase Auth Client for synchronous operations.

classsrc.supabase.src.supabase._sync.client.Client

Supabase client class.

methodsrc.supabase.src.supabase._sync.client.Client.from_(table_name:str) -> SyncRequestBuilder

Perform a table operation.

methodsrc.supabase.src.supabase._sync.client.Client.get_channels() -> List[SyncRealtimeChannel]

Returns all realtime channels.

method

src.supabase.src.supabase._sync.client.Client.rpc(fn:str, params:Optional[Dict[Any, Any]]=None, count:Optional[CountMethod]=None, head:bool=False, get:bool=False) -> SyncRPCFilterRequestBuilder

Performs a stored procedure call.

methodsrc.supabase.src.supabase._sync.client.Client.schema(schema:str) -> SyncPostgrestClient

Select a schema to query or perform an function (rpc) call.

methodsrc.supabase.src.supabase._sync.client.Client.table(table_name:str) -> SyncRequestBuilder

Perform a table operation.

About this data

These signatures were extracted from the public source of supabase/supabase-py using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries