shizmob / pydle

An IRCv3-compliant Python 3 IRC library.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[compat] Add proxy property to pydle.Client.PING_TIMEOUT for reverse compatability

theunkn0wn1 opened this issue · comments

#124 renamed pydle.Client.PING_TIMEOUT to pydle.Client.READ_TIMEOUT, which may effect downstream users as Pydle's public interface changed.
I suspect this change was named to keep the variable appropriately named, however for the sake of compatibility with existing code we should preserve the old name too, for the time being.

What i propose is a proxy property using the old name, which will log a deprecation warning in Pydle 0.9.3 onwards. At some point down the line, possibly 0.10.0 or later, this proxy can be removed.

This will allow old code to continue to work, while giving developers a warning so they can migrate existing code to the new variable