Merge lp:~mnordhoff/bzr/bencode-deprecation-stacklevel into lp:~bzr/bzr/trunk-old

[Matt Nordhoff]

[Matt Nordhoff (mnordhoff)]

Look, another trivial patch.

bzrlib.util.bencode's deprecation warning didn't pass stacklevel=2, so it just said:

.../bzrlib/util/bencode.py:22: DeprecationWarning: bzrlib.util.bencode was deprecated in version 1.16.

...which is rather unhelpful.

[Martin Pool (mbp)]

review: Approve

[Matt Nordhoff (mnordhoff)]

John A Meinel wrote:
> What does it give you with stacklevel=2 ? I was considering that, but I
> didn't know what stack would give you for "import".
>
> Anyway, if it gives something more useful:
> vote approve

Seems to do the right thing:

>>> import bzrlib.util.bencode
__main__:1: DeprecationWarning: bzrlib.util.bencode was deprecated in
version 1.16.
  Use bzrlib.bencode instead

Less so when you use lazy_import, but it's not really any worse:

>>> lazy_import(globals(), "import bzrlib.util.bencode")
>>> bzrlib.util.bencode.__doc__
bzrlib/lazy_import.py:195: DeprecationWarning: bzrlib.util.bencode was
deprecated in version 1.16.
  Use bzrlib.bencode instead
  module = __import__(module_python_path, scope, scope, [])
--

=== modified file 'bzrlib/util/bencode.py'
--- bzrlib/util/bencode.py	2009-06-09 14:18:41 +0000
+++ bzrlib/util/bencode.py	2009-06-24 02:35:16 +0000
@@ -19,6 +19,6 @@
 dep_warning = symbol_versioning.deprecated_in((1, 16, 0)) % (
     'bzrlib.util.bencode',) + '\n  Use bzrlib.bencode instead'
 
-symbol_versioning.warn(dep_warning, DeprecationWarning)
+symbol_versioning.warn(dep_warning, DeprecationWarning, stacklevel=2)
 
 from bzrlib.bencode import *