# testing/warnings.py

# Copyright (C) 2005-2020 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





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(

        "ignore",

        category=sa_exc.SAWarning,

        message=r"Oracle compatibility version .* is known to have a "

        "maximum identifier",

    )



    # some selected deprecations...

    warnings.filterwarnings("error", category=DeprecationWarning)

    warnings.filterwarnings(

        "ignore", category=DeprecationWarning, message=".*StopIteration"

    )

    warnings.filterwarnings(

        "ignore", category=DeprecationWarning, message=".*inspect.getargspec"

    )



    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()