summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine/strategies.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/sqlalchemy/engine/strategies.py')
-rw-r--r--lib/sqlalchemy/engine/strategies.py120
1 files changed, 70 insertions, 50 deletions
diff --git a/lib/sqlalchemy/engine/strategies.py b/lib/sqlalchemy/engine/strategies.py
index d4f5185de..4aecb9537 100644
--- a/lib/sqlalchemy/engine/strategies.py
+++ b/lib/sqlalchemy/engine/strategies.py
@@ -51,18 +51,20 @@ class DefaultEngineStrategy(EngineStrategy):
plugins = u._instantiate_plugins(kwargs)
- u.query.pop('plugin', None)
- kwargs.pop('plugins', None)
+ u.query.pop("plugin", None)
+ kwargs.pop("plugins", None)
entrypoint = u._get_entrypoint()
dialect_cls = entrypoint.get_dialect_cls(u)
- if kwargs.pop('_coerce_config', False):
+ if kwargs.pop("_coerce_config", False):
+
def pop_kwarg(key, default=None):
value = kwargs.pop(key, default)
if key in dialect_cls.engine_config_types:
value = dialect_cls.engine_config_types[key](value)
return value
+
else:
pop_kwarg = kwargs.pop
@@ -72,7 +74,7 @@ class DefaultEngineStrategy(EngineStrategy):
if k in kwargs:
dialect_args[k] = pop_kwarg(k)
- dbapi = kwargs.pop('module', None)
+ dbapi = kwargs.pop("module", None)
if dbapi is None:
dbapi_args = {}
for k in util.get_func_kwargs(dialect_cls.dbapi):
@@ -80,7 +82,7 @@ class DefaultEngineStrategy(EngineStrategy):
dbapi_args[k] = pop_kwarg(k)
dbapi = dialect_cls.dbapi(**dbapi_args)
- dialect_args['dbapi'] = dbapi
+ dialect_args["dbapi"] = dbapi
for plugin in plugins:
plugin.handle_dialect_kwargs(dialect_cls, dialect_args)
@@ -90,41 +92,43 @@ class DefaultEngineStrategy(EngineStrategy):
# assemble connection arguments
(cargs, cparams) = dialect.create_connect_args(u)
- cparams.update(pop_kwarg('connect_args', {}))
+ cparams.update(pop_kwarg("connect_args", {}))
cargs = list(cargs) # allow mutability
# look for existing pool or create
- pool = pop_kwarg('pool', None)
+ pool = pop_kwarg("pool", None)
if pool is None:
+
def connect(connection_record=None):
if dialect._has_events:
for fn in dialect.dispatch.do_connect:
connection = fn(
- dialect, connection_record, cargs, cparams)
+ dialect, connection_record, cargs, cparams
+ )
if connection is not None:
return connection
return dialect.connect(*cargs, **cparams)
- creator = pop_kwarg('creator', connect)
+ creator = pop_kwarg("creator", connect)
- poolclass = pop_kwarg('poolclass', None)
+ poolclass = pop_kwarg("poolclass", None)
if poolclass is None:
poolclass = dialect_cls.get_pool_class(u)
- pool_args = {
- 'dialect': dialect
- }
+ pool_args = {"dialect": dialect}
# consume pool arguments from kwargs, translating a few of
# the arguments
- translate = {'logging_name': 'pool_logging_name',
- 'echo': 'echo_pool',
- 'timeout': 'pool_timeout',
- 'recycle': 'pool_recycle',
- 'events': 'pool_events',
- 'use_threadlocal': 'pool_threadlocal',
- 'reset_on_return': 'pool_reset_on_return',
- 'pre_ping': 'pool_pre_ping',
- 'use_lifo': 'pool_use_lifo'}
+ translate = {
+ "logging_name": "pool_logging_name",
+ "echo": "echo_pool",
+ "timeout": "pool_timeout",
+ "recycle": "pool_recycle",
+ "events": "pool_events",
+ "use_threadlocal": "pool_threadlocal",
+ "reset_on_return": "pool_reset_on_return",
+ "pre_ping": "pool_pre_ping",
+ "use_lifo": "pool_use_lifo",
+ }
for k in util.get_cls_kwargs(poolclass):
tk = translate.get(k, k)
if tk in kwargs:
@@ -149,7 +153,7 @@ class DefaultEngineStrategy(EngineStrategy):
if k in kwargs:
engine_args[k] = pop_kwarg(k)
- _initialize = kwargs.pop('_initialize', True)
+ _initialize = kwargs.pop("_initialize", True)
# all kwargs should be consumed
if kwargs:
@@ -157,32 +161,40 @@ class DefaultEngineStrategy(EngineStrategy):
"Invalid argument(s) %s sent to create_engine(), "
"using configuration %s/%s/%s. Please check that the "
"keyword arguments are appropriate for this combination "
- "of components." % (','.join("'%s'" % k for k in kwargs),
- dialect.__class__.__name__,
- pool.__class__.__name__,
- engineclass.__name__))
+ "of components."
+ % (
+ ",".join("'%s'" % k for k in kwargs),
+ dialect.__class__.__name__,
+ pool.__class__.__name__,
+ engineclass.__name__,
+ )
+ )
engine = engineclass(pool, dialect, u, **engine_args)
if _initialize:
do_on_connect = dialect.on_connect()
if do_on_connect:
+
def on_connect(dbapi_connection, connection_record):
conn = getattr(
- dbapi_connection, '_sqla_unwrap', dbapi_connection)
+ dbapi_connection, "_sqla_unwrap", dbapi_connection
+ )
if conn is None:
return
do_on_connect(conn)
- event.listen(pool, 'first_connect', on_connect)
- event.listen(pool, 'connect', on_connect)
+ event.listen(pool, "first_connect", on_connect)
+ event.listen(pool, "connect", on_connect)
def first_connect(dbapi_connection, connection_record):
- c = base.Connection(engine, connection=dbapi_connection,
- _has_events=False)
+ c = base.Connection(
+ engine, connection=dbapi_connection, _has_events=False
+ )
c._execution_options = util.immutabledict()
dialect.initialize(c)
- event.listen(pool, 'first_connect', first_connect, once=True)
+
+ event.listen(pool, "first_connect", first_connect, once=True)
dialect_cls.engine_created(engine)
if entrypoint is not dialect_cls:
@@ -197,18 +209,20 @@ class DefaultEngineStrategy(EngineStrategy):
class PlainEngineStrategy(DefaultEngineStrategy):
"""Strategy for configuring a regular Engine."""
- name = 'plain'
+ name = "plain"
engine_cls = base.Engine
+
PlainEngineStrategy()
class ThreadLocalEngineStrategy(DefaultEngineStrategy):
"""Strategy for configuring an Engine with threadlocal behavior."""
- name = 'threadlocal'
+ name = "threadlocal"
engine_cls = threadlocal.TLEngine
+
ThreadLocalEngineStrategy()
@@ -220,7 +234,7 @@ class MockEngineStrategy(EngineStrategy):
"""
- name = 'mock'
+ name = "mock"
def create(self, name_or_url, executor, **kwargs):
# create url.URL object
@@ -245,7 +259,7 @@ class MockEngineStrategy(EngineStrategy):
self.execute = execute
engine = property(lambda s: s)
- dialect = property(attrgetter('_dialect'))
+ dialect = property(attrgetter("_dialect"))
name = property(lambda s: s._dialect.name)
schema_for_object = schema._schema_getter(None)
@@ -258,29 +272,35 @@ class MockEngineStrategy(EngineStrategy):
def compiler(self, statement, parameters, **kwargs):
return self._dialect.compiler(
- statement, parameters, engine=self, **kwargs)
+ statement, parameters, engine=self, **kwargs
+ )
def create(self, entity, **kwargs):
- kwargs['checkfirst'] = False
+ kwargs["checkfirst"] = False
from sqlalchemy.engine import ddl
- ddl.SchemaGenerator(
- self.dialect, self, **kwargs).traverse_single(entity)
+ ddl.SchemaGenerator(self.dialect, self, **kwargs).traverse_single(
+ entity
+ )
def drop(self, entity, **kwargs):
- kwargs['checkfirst'] = False
+ kwargs["checkfirst"] = False
from sqlalchemy.engine import ddl
- ddl.SchemaDropper(
- self.dialect, self, **kwargs).traverse_single(entity)
- def _run_visitor(self, visitorcallable, element,
- connection=None,
- **kwargs):
- kwargs['checkfirst'] = False
- visitorcallable(self.dialect, self,
- **kwargs).traverse_single(element)
+ ddl.SchemaDropper(self.dialect, self, **kwargs).traverse_single(
+ entity
+ )
+
+ def _run_visitor(
+ self, visitorcallable, element, connection=None, **kwargs
+ ):
+ kwargs["checkfirst"] = False
+ visitorcallable(self.dialect, self, **kwargs).traverse_single(
+ element
+ )
def execute(self, object, *multiparams, **params):
raise NotImplementedError()
+
MockEngineStrategy()