Path: csiph.com!v102.xanadu-bbs.net!xanadu-bbs.net!news.mixmin.net!feeder.erje.net!newsfeed.xs4all.nl!newsfeed6.news.xs4all.nl!xs4all!post.news.xs4all.nl!not-for-mail
MIME-Version: 1.0
In-Reply-To: <jkqjd4$1cp$1@dough.gmane.org>
References: <jkqjd4$1cp$1@dough.gmane.org>
Date: Tue, 27 Mar 2012 08:50:35 +1100
Subject: Re: best way to create warning for obsolete functions and call new one
From: Chris Angelico <rosuav@gmail.com>
To: python-list@python.org
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable
Precedence: list
Newsgroups: comp.lang.python
Message-ID: <mailman.1020.1332798644.3037.python-list@python.org>
Lines: 59
NNTP-Posting-Host: 2001:888:2000:d::a6
Xref: csiph.com comp.lang.python:22212

On Tue, Mar 27, 2012 at 7:26 AM, Gelonida N <gelonida@gmail.com> wrote:
> One option I though of would be:
>
> def obsolete_func(func):
> =A0 =A0def call_old(*args, **kwargs):
> =A0 =A0 =A0 =A0print "func is old psl use new one"
> =A0 =A0 =A0 =A0return func(*args, **kwargs)
> =A0 =A0return call_old
>
> and
>
> def get_time(a=3D'high'):
> =A0 return a + 'noon'

That's a reasonable idea. Incorporate Dan's suggestion of using
DeprecationWarning.

You may want to try decorator syntax:

def was(oldname):
	def _(func):
		globals()[oldname]=3Dfunc
		return func
	return _

@was("get_thyme")
def get_time(a=3D'high'):
   return a + 'noon'

That won't raise DeprecationWarning, though. It's a very simple
assignment. The was() internal function could be enhanced to do a bit
more work, but I'm not sure what version of Python you're using and
what introspection facilities you have. But if you're happy with the
old versions coming up with (*args,**kwargs) instead of their
parameter lists, it's not difficult:

def was(oldname):
	def _(func):
		def bounce(*args,**kwargs):
			# raise DeprecationWarning
			return func(*args,**kwargs)
		globals()[oldname]=3Dbounce
		return func
	return _

I've never actually used the Python warnings module, but any line of
code you fill in at the comment will be executed any time the old name
is used. In any case, it's still used with the same convenient
decorator. You could even unify multiple functions under a single new
name:

@was("foo")
@was("bar")
def quux(spam,ham):
    return ham.eat()

Hope that helps!

ChrisA