aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/Twisted/py3/twisted/internet/_deprecate.py
blob: 6eb1e3855f9fab18486e0d55ad503b51601cf827 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
"""
Support similar deprecation of several reactors.
"""

import warnings

from incremental import Version, getVersionString

from twisted.python.deprecate import DEPRECATION_WARNING_FORMAT


def deprecatedGnomeReactor(name: str, version: Version) -> None:
    """
    Emit a deprecation warning about a gnome-related reactor.

    @param name: The name of the reactor.  For example, C{"gtk2reactor"}.

    @param version: The version in which the deprecation was introduced.
    """
    stem = DEPRECATION_WARNING_FORMAT % {
        "fqpn": "twisted.internet." + name,
        "version": getVersionString(version),
    }
    msg = stem + ".  Please use twisted.internet.gireactor instead."
    warnings.warn(msg, category=DeprecationWarning)