MagicStack / MagicStack/asyncpg
Note which kwargs are safe to pass to Pool.set_connect_args
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 8.1k
- Fork
- 468
- Merge medio
- 18m
- PR unite (30g)
- 4
Descrizione
The documentation for asyncpg.pool.Pool.set_connect_args makes no mention that there are 2 particular kwargs that are already being passed to connect by the pool when it creates new connections: https://github.com/MagicStack/asyncpg/blob/92c2d81256a1efd8cab12c0118d74ccd1c18131b/asyncpg/pool.py#L459-L463
Before reading the source, I incorrectly assumed that any of connect's kwargs are safe to pass to Pool.set_connect_args, but if you pass either loop or connection_class you'll end up with a traceback like this:
Traceback (most recent call last):
... omitted for brevity ...
File "/usr/local/lib/python3.7/site-packages/asyncpg/pool.py", line 762, in __aenter__
self.connection = await self.pool._acquire(self.timeout)
File "/usr/local/lib/python3.7/site-packages/asyncpg/pool.py", line 604, in _acquire
return await _acquire_impl()
File "/usr/local/lib/python3.7/site-packages/asyncpg/pool.py", line 589, in _acquire_impl
proxy = await ch.acquire() # type: PoolConnectionProxy
File "/usr/local/lib/python3.7/site-packages/asyncpg/pool.py", line 133, in acquire
await self.connect()
File "/usr/local/lib/python3.7/site-packages/asyncpg/pool.py", line 125, in connect
self._con = await self._pool._get_new_connection()
File "/usr/local/lib/python3.7/site-packages/asyncpg/pool.py", line 463, in _get_new_connection
**self._connect_kwargs)
TypeError: connect() got multiple values for keyword argument 'loop'
Not hard to fix in my app, but it'd be great to update the docs to maybe save future users some time.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla documentazione dell’API asyncpg.pool.Pool.set_connect_args collegata e dalle righe 459-463 di asyncpg/pool.py indicate come riferimento. Aggiorna la documentazione per identificare loop e connection_class come kwargs già forniti dal pool e che non possono essere passati in modo sicuro. Verifica la documentazione dell’API risultante e assicurati che l’avviso corrisponda al TypeError osservato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- postgresql, python
- Ambito
- databases, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100