Mercurial > public > mercurial-scm > hg-stable
diff mercurial/util.py @ 31950:cc70c6dbac30
util: add a way to issue deprecation warning without a UI object
Our current deprecation warning mechanism relies on ui object. They are case
where we cannot have access to the UI object. On a general basis we avoid using
the python mechanism for deprecation warning because up to Python 2.6 it is
exposing warning to unsuspecting user who cannot do anything to deal with them.
So we build a "safe" strategy to hide this warnings behind a flag in an
environment variable. The test runner set this flag so that tests show these
warning. This will help us marker API as deprecated for extensions to update
their code.
| author | Pierre-Yves David <pierre-yves.david@ens-lyon.org> |
|---|---|
| date | Tue, 04 Apr 2017 11:03:29 +0200 |
| parents | f3b80537a70d |
| children | a34b5e7c6683 |
line wrap: on
line diff
--- a/mercurial/util.py Thu Apr 13 09:49:48 2017 +0200 +++ b/mercurial/util.py Tue Apr 04 11:03:29 2017 +0200 @@ -38,6 +38,7 @@ import textwrap import time import traceback +import warnings import zlib from . import ( @@ -156,6 +157,31 @@ bits |= bit return bits +# python 2.6 still have deprecation warning enabled by default. We do not want +# to display anything to standard user so detect if we are running test and +# only use python deprecation warning in this case. +_dowarn = bool(encoding.environ.get('HGEMITWARNINGS')) +if _dowarn: + # explicitly unfilter our warning for python 2.7 + # + # The option of setting PYTHONWARNINGS in the test runner was investigated. + # However, module name set through PYTHONWARNINGS was exactly matched, so + # we cannot set 'mercurial' and have it match eg: 'mercurial.scmutil'. This + # makes the whole PYTHONWARNINGS thing useless for our usecase. + warnings.filterwarnings('default', '', DeprecationWarning, 'mercurial') + warnings.filterwarnings('default', '', DeprecationWarning, 'hgext') + warnings.filterwarnings('default', '', DeprecationWarning, 'hgext3rd') + +def nouideprecwarn(msg, version, stacklevel=1): + """Issue an python native deprecation warning + + This is a noop outside of tests, use 'ui.deprecwarn' when possible. + """ + if _dowarn: + msg += ("\n(compatibility will be dropped after Mercurial-%s," + " update your code.)") % version + warnings.warn(msg, DeprecationWarning, stacklevel + 1) + DIGESTS = { 'md5': hashlib.md5, 'sha1': hashlib.sha1,