Mutable reference options.headers #1095

AsahiSoftWareEngineer · 2025-04-02T13:39:38Z

Bug report

I confirm this is a bug with Supabase, not with my own application.
I confirm I have searched the Docs, GitHub Discussions, and Discord.

Describe the bug

A clear and concise description of what the bug is.

Mutable reference options.headers

options.headers is updated in create_client directry. thats why, The headers may be changed unintentionally if it is shared ClientOptions` instance other position.

To Reproduce

Please execute below source code jupytor notebook.

from supabase import create_client
from supabase.lib.client_options import SyncClientOptions 
class settings:
    SUPABASE_URL = "https://***"
    SUPABASE_KEY = "***"
from supabase._sync.client import create_client, ClientOptions
from gotrue import SyncMemoryStorage

# Share same ClientOptions Instanc
shared_options = ClientOptions(storage=SyncMemoryStorage(), headers={"Custom-Header": "InitialValue"})

# Create client1
client1 = create_client(settings.SUPABASE_URL, settings.SUPABASE_KEY, options=shared_options)

# Create client2
client2 = create_client(settings.SUPABASE_URL, settings.SUPABASE_KEY, options=shared_options)

# Rewrite header client1
client1.options.headers["Custom-Header"] = "ModifiedValue"
client2.options.headers["Custom-Header"] = "ModifiedValue2"

# Check header client2
print(client1.options.headers["Custom-Header"])  # "ModifiedValue2"

Expected behavior

...
print(client1.options.headers["Custom-Header"])
# -> "ModifiedValue"

Screenshots

System information

mac OS
chrome
Version of supabase-py: 2.15.0
Version of Python: 3.9.0

Additional context

The text was updated successfully, but these errors were encountered:

AsahiSoftWareEngineer · 2025-04-02T13:42:33Z

@AsahiSoftWareEngineer I am going to fix bugs

gayathriramanesh · 2025-04-16T12:39:23Z

Hi @AsahiSoftWareEngineer Is this issue fixed?

AsahiSoftWareEngineer · 2025-04-16T13:14:55Z

@gayathriramanesh Hi, I think that already fixed

grdsdev · 2025-05-20T10:09:22Z

Hey all, as discussed in #1096 this isn't a bug, it is just how Python works.

If you want to change a client's options you need to use the replace method in the option.

We'll make sure this gets included in our docs.

Thanks.

Co-authored-by: Andrew Smith <[email protected]>

rild-software · 2025-05-30T05:09:04Z

a deep copy don't looks like a clever option to copy the options content to the config instance class.

I had a bug with this released:

ERROR:    Exception in ASGI application
Traceback (most recent call last):
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/uvicorn/protocols/http/h11_impl.py", line 403, in run_asgi
    result = await app(  # type: ignore[func-returns-value]
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/uvicorn/middleware/proxy_headers.py", line 60, in __call__
    return await self.app(scope, receive, send)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/fastapi/applications.py", line 1054, in __call__
    await super().__call__(scope, receive, send)
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/applications.py", line 112, in __call__
    await self.middleware_stack(scope, receive, send)
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/middleware/errors.py", line 187, in __call__
    raise exc
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/middleware/errors.py", line 165, in __call__
    await self.app(scope, receive, _send)
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/middleware/cors.py", line 85, in __call__
    await self.app(scope, receive, send)
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/middleware/exceptions.py", line 62, in __call__
    await wrap_app_handling_exceptions(self.app, conn)(scope, receive, send)
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/_exception_handler.py", line 53, in wrapped_app
    raise exc
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/_exception_handler.py", line 42, in wrapped_app
    await app(scope, receive, sender)
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/routing.py", line 714, in __call__
    await self.middleware_stack(scope, receive, send)
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/routing.py", line 734, in app
    await route.handle(scope, receive, send)
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/routing.py", line 288, in handle
    await self.app(scope, receive, send)
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/routing.py", line 76, in app
    await wrap_app_handling_exceptions(app, request)(scope, receive, send)
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/_exception_handler.py", line 53, in wrapped_app
    raise exc
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/_exception_handler.py", line 42, in wrapped_app
    await app(scope, receive, sender)
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/routing.py", line 73, in app
    response = await f(request)
               ^^^^^^^^^^^^^^^^
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/fastapi/routing.py", line 291, in app
    solved_result = await solve_dependencies(
                    ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/fastapi/dependencies/utils.py", line 640, in solve_dependencies
    solved = await run_in_threadpool(call, **solved_result.values)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/starlette/concurrency.py", line 37, in run_in_threadpool
    return await anyio.to_thread.run_sync(func)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/anyio/to_thread.py", line 56, in run_sync
    return await get_async_backend().run_sync_in_worker_thread(
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/anyio/_backends/_asyncio.py", line 2470, in run_sync_in_worker_thread
    return await future
           ^^^^^^^^^^^^
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/anyio/_backends/_asyncio.py", line 967, in run
    result = context.run(func, *args)
             ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/ricardo/Dev/api_portalcannabis/app/core/database.py", line 54, in get_supabase
    return create_client(
           ^^^^^^^^^^^^^^
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/supabase/_sync/client.py", line 341, in create_client
    return SyncClient.create(
           ^^^^^^^^^^^^^^^^^^
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/supabase/_sync/client.py", line 103, in create
    client = cls(supabase_url, supabase_key, options)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/ricardo/Dev/api_portalcannabis/.venv/lib/python3.12/site-packages/supabase/_sync/client.py", line 71, in __init__
    self.options = copy.deepcopy(options)
                   ^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 162, in deepcopy
    y = _reconstruct(x, memo, *rv)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 259, in _reconstruct
    state = deepcopy(state, memo)
            ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 136, in deepcopy
    y = copier(x, memo)
        ^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 221, in _deepcopy_dict
    y[deepcopy(key, memo)] = deepcopy(value, memo)
                             ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 162, in deepcopy
    y = _reconstruct(x, memo, *rv)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 259, in _reconstruct
    state = deepcopy(state, memo)
            ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 136, in deepcopy
    y = copier(x, memo)
        ^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 221, in _deepcopy_dict
    y[deepcopy(key, memo)] = deepcopy(value, memo)
                             ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 162, in deepcopy
    y = _reconstruct(x, memo, *rv)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 259, in _reconstruct
    state = deepcopy(state, memo)
            ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 136, in deepcopy
    y = copier(x, memo)
        ^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 221, in _deepcopy_dict
    y[deepcopy(key, memo)] = deepcopy(value, memo)
                             ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 162, in deepcopy
    y = _reconstruct(x, memo, *rv)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 259, in _reconstruct
    state = deepcopy(state, memo)
            ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 136, in deepcopy
    y = copier(x, memo)
        ^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 221, in _deepcopy_dict
    y[deepcopy(key, memo)] = deepcopy(value, memo)
                             ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 162, in deepcopy
    y = _reconstruct(x, memo, *rv)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 259, in _reconstruct
    state = deepcopy(state, memo)
            ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 136, in deepcopy
    y = copier(x, memo)
        ^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 221, in _deepcopy_dict
    y[deepcopy(key, memo)] = deepcopy(value, memo)
                             ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 162, in deepcopy
    y = _reconstruct(x, memo, *rv)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 259, in _reconstruct
    state = deepcopy(state, memo)
            ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 136, in deepcopy
    y = copier(x, memo)
        ^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 221, in _deepcopy_dict
    y[deepcopy(key, memo)] = deepcopy(value, memo)
                             ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 162, in deepcopy
    y = _reconstruct(x, memo, *rv)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 259, in _reconstruct
    state = deepcopy(state, memo)
            ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 136, in deepcopy
    y = copier(x, memo)
        ^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 221, in _deepcopy_dict
    y[deepcopy(key, memo)] = deepcopy(value, memo)
                             ^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/copy.py", line 151, in deepcopy
    rv = reductor(4)
         ^^^^^^^^^^^
TypeError: cannot pickle '_thread.RLock' object

rild-software · 2025-05-30T05:10:17Z

If I change the line 71 of supabase._sync.client.py from
self.options = copy.deepcopy(options)
to
self.options = copy.copy(options)

It's solve this problem

rild-software · 2025-05-30T05:10:34Z

I will open a issue

AsahiSoftWareEngineer added the bug Something isn't working label Apr 2, 2025

AsahiSoftWareEngineer mentioned this issue Apr 2, 2025

fix: mutable reference headers #1095 #1096

Merged

grdsdev added the python Pull requests that update Python code label Apr 4, 2025 — with Linear

supabase deleted a comment from brambhattabhishek Apr 9, 2025

grdsdev closed this as completed May 20, 2025

silentworks added a commit that referenced this issue May 23, 2025

fix: mutable reference headers #1095 (#1096)

50d79c1

Co-authored-by: Andrew Smith <[email protected]>

github-actions bot mentioned this issue May 23, 2025

chore(main): release 2.15.2 #1127

Merged

This was referenced May 30, 2025

SyncClient init shouldn't deep copy options content to avoid pickling error #1129

Closed

fix: copy client options instead of deepcopy #1130

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Mutable reference options.headers #1095

Mutable reference options.headers #1095

AsahiSoftWareEngineer commented Apr 2, 2025

AsahiSoftWareEngineer commented Apr 2, 2025

Uh oh!

gayathriramanesh commented Apr 16, 2025

Uh oh!

AsahiSoftWareEngineer commented Apr 16, 2025

Uh oh!

grdsdev commented May 20, 2025

Uh oh!

rild-software commented May 30, 2025

Uh oh!

rild-software commented May 30, 2025

Uh oh!

rild-software commented May 30, 2025

Uh oh!

Uh oh!

Mutable reference options.headers #1095

Mutable reference options.headers #1095

Comments

AsahiSoftWareEngineer commented Apr 2, 2025

Bug report

Describe the bug

To Reproduce

Expected behavior

Screenshots

System information

Additional context

AsahiSoftWareEngineer commented Apr 2, 2025

Uh oh!

gayathriramanesh commented Apr 16, 2025

Uh oh!

AsahiSoftWareEngineer commented Apr 16, 2025

Uh oh!

grdsdev commented May 20, 2025

Uh oh!

rild-software commented May 30, 2025

Uh oh!

rild-software commented May 30, 2025

Uh oh!

rild-software commented May 30, 2025

Uh oh!