summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine/default.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2020-03-02 10:28:32 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2020-03-02 10:28:32 -0500
commit649de79950dcf952d7a44069faf36925c23c4e63 (patch)
tree04e006c3ffa734b8c99fa90d85113d0fef8e1879 /lib/sqlalchemy/engine/default.py
parent5627fc68f60eb1362ff394930255dbb725a569b2 (diff)
downloadsqlalchemy-649de79950dcf952d7a44069faf36925c23c4e63.tar.gz
Update dialect API documentation
The docstrings for connect() and on_connect() were incorrect between Dialect vs. DefaultDialect. Redocumented related methods, clean up formatting, and remove unicode-related attribute descriptions from the top level Dialect document as these don't apply to Python 3. Change-Id: I45baab757f8e20627eba42c30b9e8dbe26356275
Diffstat (limited to 'lib/sqlalchemy/engine/default.py')
-rw-r--r--lib/sqlalchemy/engine/default.py14
1 files changed, 3 insertions, 11 deletions
diff --git a/lib/sqlalchemy/engine/default.py b/lib/sqlalchemy/engine/default.py
index 7efc4bda2..28a59e660 100644
--- a/lib/sqlalchemy/engine/default.py
+++ b/lib/sqlalchemy/engine/default.py
@@ -338,17 +338,7 @@ class DefaultDialect(interfaces.Dialect):
)
def on_connect(self):
- """return a callable which sets up a newly created DBAPI connection.
-
- This is used to set dialect-wide per-connection options such as
- isolation modes, unicode modes, etc.
-
- If a callable is returned, it will be assembled into a pool listener
- that receives the direct DBAPI connection, with all wrappers removed.
-
- If None is returned, no listener will be generated.
-
- """
+ # inherits the docstring from interfaces.Dialect.on_connect
return None
def _check_max_identifier_length(self, connection):
@@ -478,9 +468,11 @@ class DefaultDialect(interfaces.Dialect):
)
def connect(self, *cargs, **cparams):
+ # inherits the docstring from interfaces.Dialect.connect
return self.dbapi.connect(*cargs, **cparams)
def create_connect_args(self, url):
+ # inherits the docstring from interfaces.Dialect.create_connect_args
opts = url.translate_connect_args()
opts.update(url.query)
return [[], opts]