|
- # testing/warnings.py
- # Copyright (C) 2005-2021 the SQLAlchemy authors and contributors
- # <see AUTHORS file>
- #
- # This module is part of SQLAlchemy and is released under
- # the MIT License: http://www.opensource.org/licenses/mit-license.php
-
- from __future__ import absolute_import
-
- import warnings
-
- from . import assertions
- from .. import exc as sa_exc
- from ..util.langhelpers import _warnings_warn
-
-
- class SATestSuiteWarning(sa_exc.SAWarning):
- """warning for a condition detected during tests that is non-fatal"""
-
-
- def warn_test_suite(message):
- _warnings_warn(message, category=SATestSuiteWarning)
-
-
- def setup_filters():
- """Set global warning behavior for the test suite."""
-
- warnings.filterwarnings(
- "ignore", category=sa_exc.SAPendingDeprecationWarning
- )
- warnings.filterwarnings("error", category=sa_exc.SADeprecationWarning)
- warnings.filterwarnings("error", category=sa_exc.SAWarning)
- warnings.filterwarnings("always", category=SATestSuiteWarning)
-
- # some selected deprecations...
- warnings.filterwarnings("error", category=DeprecationWarning)
- warnings.filterwarnings(
- "ignore", category=DeprecationWarning, message=r".*StopIteration"
- )
- warnings.filterwarnings(
- "ignore",
- category=DeprecationWarning,
- message=r".*inspect.get.*argspec",
- )
-
- warnings.filterwarnings(
- "ignore",
- category=DeprecationWarning,
- message="The loop argument is deprecated",
- )
-
- # ignore things that are deprecated *as of* 2.0 :)
- warnings.filterwarnings(
- "ignore",
- category=sa_exc.SADeprecationWarning,
- message=r".*\(deprecated since: 2.0\)$",
- )
- warnings.filterwarnings(
- "ignore",
- category=sa_exc.SADeprecationWarning,
- message=r"^The (Sybase|firebird) dialect is deprecated and will be",
- )
-
- # 2.0 deprecation warnings, which we will want to have all of these
- # be "error" however for I98b8defdf7c37b818b3824d02f7668e3f5f31c94
- # we are moving one at a time
- for msg in [
- #
- # Core execution
- #
- r"The (?:Executable|Engine)\.(?:execute|scalar)\(\) method",
- r"The Connection.connect\(\) method is considered legacy",
- # r".*DefaultGenerator.execute\(\)",
- #
- #
- #
- # Core SQL constructs
- #
- r"The FromClause\.select\(\).whereclause parameter is deprecated",
- r"Set functions such as union\(\), union_all\(\), extract\(\),",
- r"The legacy calling style of select\(\) is deprecated and will be "
- "removed",
- r"The FromClause.select\(\) method will no longer accept keyword "
- "arguments in version 2.0",
- r"The Join.select\(\) method will no longer accept keyword arguments "
- "in version 2.0.",
- r"The \"whens\" argument to case\(\) is now passed",
- r"The Join.select\(\).whereclause parameter is deprecated",
- #
- # DML
- #
- r"The (?:update|delete).whereclause parameter will be removed in "
- "SQLAlchemy 2.0.",
- r"The (?:insert|update).values parameter will be removed in "
- "SQLAlchemy 2.0.",
- r"The update.preserve_parameter_order parameter will be removed in "
- "SQLAlchemy 2.0.",
- r"Passing dialect keyword arguments directly to the "
- "(?:Insert|Update|Delete) constructor",
- #
- # ORM configuration
- #
- r"Calling the mapper\(\) function directly outside of a "
- "declarative registry",
- r"The ``declarative_base\(\)`` function is now available ",
- r"The ``has_inherited_table\(\)`` function is now available",
- r"The ``bind`` argument to declarative_base is deprecated and will "
- "be removed in SQLAlchemy 2.0.",
- #
- # ORM Query
- #
- r"The Query\.get\(\) method",
- r"The Query\.from_self\(\) method",
- r"The Query\.with_parent\(\) method",
- r"The Query\.with_parent\(\) method",
- r"The Query\.select_entity_from\(\) method",
- r"The ``aliased`` and ``from_joinpoint`` keyword arguments",
- r"Using strings to indicate relationship names in Query.join",
- r"Using strings to indicate column or relationship paths in "
- "loader options",
- r"Using strings to indicate relationship names in the ORM "
- r"with_parent\(\)",
- r"The Query.with_polymorphic\(\) method is considered "
- "legacy as of the 1.x series",
- r"Passing a chain of multiple join conditions to Query.join\(\) "
- r"is deprecated and will be removed in SQLAlchemy 2.0.",
- r"Query.join\(\) will no longer accept tuples as arguments",
- #
- # ORM Session
- #
- r"This Session located a target engine via bound metadata",
- r"The Session.autocommit parameter is deprecated ",
- r".*object is being merged into a Session along the backref "
- "cascade path",
- r"Passing bind arguments to Session.execute\(\) as keyword arguments",
- r"The merge_result\(\) method is superseded by the "
- r"merge_frozen_result\(\)",
- r"The Session.begin.subtransactions flag is deprecated",
- ]:
- warnings.filterwarnings(
- "ignore",
- message=msg,
- category=sa_exc.RemovedIn20Warning,
- )
-
- try:
- import pytest
- except ImportError:
- pass
- else:
- warnings.filterwarnings(
- "once", category=pytest.PytestDeprecationWarning
- )
-
-
- def assert_warnings(fn, warning_msgs, regex=False):
- """Assert that each of the given warnings are emitted by fn.
-
- Deprecated. Please use assertions.expect_warnings().
-
- """
-
- with assertions._expect_warnings(
- sa_exc.SAWarning, warning_msgs, regex=regex
- ):
- return fn()
|