summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/util/deprecations.py
diff options
context:
space:
mode:
authorStephen Rosen <sirosen@globus.org>2021-05-07 15:45:47 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2021-05-10 19:02:35 -0400
commit1a7d8005ccf4a48a3008caaf66b309be93287774 (patch)
tree0c8f1355e6b330c4b669d371df87b721e410dc3f /lib/sqlalchemy/util/deprecations.py
parent39c2815fb25052c181f98ca52a57fd7449d7090c (diff)
downloadsqlalchemy-1a7d8005ccf4a48a3008caaf66b309be93287774.tar.gz
Improve cascade backrefs warning and add `code` to deprecation warnings
This adds a new description to errors.rst and adds support for any SQLAlchemy warning to refer to an errors.rst code. Fixes: #6148 Closes: #6250 Pull-request: https://github.com/sqlalchemy/sqlalchemy/pull/6250 Pull-request-sha: dbcaeb54e31517fe88f6f8c515f1024002675f13 Change-Id: I4303c62ac9b1f13f67a34f825687014f1771c98c
Diffstat (limited to 'lib/sqlalchemy/util/deprecations.py')
-rw-r--r--lib/sqlalchemy/util/deprecations.py26
1 files changed, 13 insertions, 13 deletions
diff --git a/lib/sqlalchemy/util/deprecations.py b/lib/sqlalchemy/util/deprecations.py
index 19c55aa33..425a5f044 100644
--- a/lib/sqlalchemy/util/deprecations.py
+++ b/lib/sqlalchemy/util/deprecations.py
@@ -26,42 +26,42 @@ if os.getenv("SQLALCHEMY_WARN_20", "false").lower() in ("true", "yes", "1"):
SQLALCHEMY_WARN_20 = True
-def _warn_with_version(msg, version, type_, stacklevel):
- is_20 = issubclass(type_, exc.RemovedIn20Warning)
-
- if is_20 and not SQLALCHEMY_WARN_20:
+def _warn_with_version(msg, version, type_, stacklevel, code=None):
+ if issubclass(type_, exc.RemovedIn20Warning) and not SQLALCHEMY_WARN_20:
return
- if is_20:
- msg += " (Background on SQLAlchemy 2.0 at: http://sqlalche.me/e/b8d9)"
-
- warn = type_(msg)
+ warn = type_(msg, code=code)
warn.deprecated_since = version
_warnings_warn(warn, stacklevel=stacklevel + 1)
-def warn_deprecated(msg, version, stacklevel=3):
- _warn_with_version(msg, version, exc.SADeprecationWarning, stacklevel)
+def warn_deprecated(msg, version, stacklevel=3, code=None):
+ _warn_with_version(
+ msg, version, exc.SADeprecationWarning, stacklevel, code=code
+ )
-def warn_deprecated_limited(msg, args, version, stacklevel=3):
+def warn_deprecated_limited(msg, args, version, stacklevel=3, code=None):
"""Issue a deprecation warning with a parameterized string,
limiting the number of registrations.
"""
if args:
msg = _hash_limit_string(msg, 10, args)
- _warn_with_version(msg, version, exc.SADeprecationWarning, stacklevel)
+ _warn_with_version(
+ msg, version, exc.SADeprecationWarning, stacklevel, code=code
+ )
-def warn_deprecated_20(msg, stacklevel=3):
+def warn_deprecated_20(msg, stacklevel=3, code=None):
_warn_with_version(
msg,
exc.RemovedIn20Warning.deprecated_since,
exc.RemovedIn20Warning,
stacklevel,
+ code=code,
)