summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2019-03-08 14:42:24 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2019-03-08 14:42:24 -0500
commit7b0dfe3c4659b651da614d5d507a03d2c4127b17 (patch)
tree73489aa76a0d747bf9c01c99e5888d8c5be51c94 /lib/sqlalchemy/engine
parent312d529dbbaa9bb7d8d804280cb39797c6402931 (diff)
downloadsqlalchemy-7b0dfe3c4659b651da614d5d507a03d2c4127b17.tar.gz
Remove convert_unicode nodes and add version for deprecation
Fixes: #4535 Change-Id: Ic5b1991ecef3b258573e1c59f5106a534f92a813
Diffstat (limited to 'lib/sqlalchemy/engine')
-rw-r--r--lib/sqlalchemy/engine/__init__.py43
1 files changed, 5 insertions, 38 deletions
diff --git a/lib/sqlalchemy/engine/__init__.py b/lib/sqlalchemy/engine/__init__.py
index fbf346cec..e75fd2900 100644
--- a/lib/sqlalchemy/engine/__init__.py
+++ b/lib/sqlalchemy/engine/__init__.py
@@ -81,7 +81,6 @@ from ..sql import ddl # noqa
default_strategy = "plain"
-
def create_engine(*args, **kwargs):
"""Create a new :class:`.Engine` instance.
@@ -147,44 +146,12 @@ def create_engine(*args, **kwargs):
columns to accommodate Python Unicode objects directly as though the
datatype were the :class:`.Unicode` type.
- .. deprecated:: The :paramref:`.create_engine.convert_unicode` flag
- and related Unicode conversion features are legacy Python 2
- mechanisms which no longer have relevance under Python 3.
- As all modern DBAPIs now support Python Unicode fully even
- under Python 2, these flags will be removed in an upcoming
- release.
-
- .. note::
-
- SQLAlchemy's unicode-conversion flags and features only apply
- to Python 2; in Python 3, all string objects are Unicode objects.
- For this reason, as well as the fact that virtually all modern
- DBAPIs now support Unicode natively even under Python 2,
- the :paramref:`.Engine.convert_unicode` flag is inherently a
- legacy feature.
-
- .. note::
-
- This flag does **not** imply that SQLAlchemy's unicode-conversion
- services will be used, as all modern DBAPIs already handle
- unicode natively; in most cases it only indicates that the
- :class:`.String` datatype will return Python unicode objects,
- rather than plain strings. The :class:`.String` datatype itself
- has additional options to force the usage of SQLAlchemy's unicode
- converters.
-
- .. note::
-
- This flag does **not** impact "raw" SQL statements that have no
- typing information set up; that is, if the :class:`.String`
- datatype is not used, no unicode behavior is implied.
-
- .. seealso::
-
- :paramref:`.String.convert_unicode` - the flag local to the
- :class:`.String` datatype has additional options
- which can force unicode handling on a per-type basis.
+ .. deprecated:: 1.3
+ The :paramref:`.create_engine.convert_unicode` parameter
+ is deprecated and will be removed in a future release.
+ All modern DBAPIs now support Python Unicode directly and this
+ parameter is unnecessary.
:param creator: a callable which returns a DBAPI connection.
This creation function will be passed to the underlying