Class FixedSizePool (1.11.0)

FixedSizePool(size=10, default_timeout=10, labels=None)

Concrete session pool implementation:

  • Pre-allocates / creates a fixed number of sessions.

  • "Pings" existing sessions via session.exists before returning them, and replaces expired sessions.

  • Blocks, with a timeout, when get is called on an empty pool. Raises after timing out.

  • Raises when put is called on a full pool. That error is never expected in normal practice, as users should be calling get followed by put whenever in need of a session.

Parameters

NameDescription
size int

fixed pool size

default_timeout int

default timeout, in seconds, to wait for a returned session.

labels dict (str -> str) or None

(Optional) user-assigned labels for sessions created by the pool.

Properties

labels

User-assigned labels for sesions created by the pool.

Returns
TypeDescription
dict (str -> str)labels assigned by the user

Methods

bind

bind(database)

Associate the pool with a database.

Parameter
NameDescription
database Database

database used by the pool: used to create sessions when needed.

clear

clear()

Delete all sessions in the pool.

get

get(timeout=None)

Check a session out from the pool.

Parameter
NameDescription
timeout int

seconds to block waiting for an available session

Exceptions
TypeDescription
`six.moves.queue.Emptyif the queue is empty.
Returns
TypeDescription
Sessionan existing session from the pool, or a newly-created session.

put

put(session)

Return a session to the pool.

Never blocks: if the pool is full, raises.

Parameter
NameDescription
session Session

the session being returned.

Exceptions
TypeDescription
`six.moves.queue.Fullif the queue is full.

session

session(**kwargs)

Check out a session from the pool.

Returns
TypeDescription
SessionCheckouta checkout instance, to be used as a context manager for accessing the session and returning it to the pool.