Skip to main content

a simple way to remember to remove dead code due to notanymore supported

Project description

Some stupid badges:

https://badge.fury.io/py/insupportable.png https://travis-ci.org/Carreau/insupportable.png?branch=master

I am really annoyed, more and more, especially in old project to figure out what code is a war a workaround for old version of python, or another library.

This library should provide a simple way to warn you as early as possible when you can remove some legacy code, that deals with unsupported library version.

By default come pre-configured with Python 2/3 convenience function, but works with other libraries and more fine grained version numbering.

# warn you you have dead code if you
# drop Python2 support
from insupportable import support
if support('PY2'):
    print("You are on python 2")
else:
    print("You are on python 3")
# warn you you have dead code if you
# drop Python2 support
from insupportable import support
if support('PY3'):
    print("You are on python 3")
else:
    print("You are on python 2")

Set it up to drop Python2 support.

Quick and dirty way, modify global config, which is not recommended as it may affect other libraries that use this too, but super usefull.

support.config(PY2=False)

if support(PY2):
    print("You are on python 2")
else:
    print("You are on python 3")

warn the following:

mymodule/myfile.py:3: UserWarning: You are not supporting PY2 anymore
  if support(PY2):
mymodule/myfile.py:3: UserWarning: PY2 is the last supported feature of this group, you can simplifiy this logic.
  if support(PY2):

More involve way, create a config context that have effect only locally:

from insupportable import S

support = S(PY2=False).support

....

Advance configuration/custom features:

Example:

support.config(config=({
    'WindowsPhone':True,
    'Android'     :False,
    'iOS'         :False
   },))
if support('WindowsPhone'):
    print('Click on start menu')
else:
    print("Probably Android - but you don't support it anymore")
mymodule/myfile.py:1: UserWarning: WindowsPhone is the last supported feature of this group, you can simplifiy this logic.
  if support('WindowsPhone'):

TODO:

Write predicates and document like:

if workaround('tornado==2.2'):
    # do something special

The predicate would decide wether or not to yield depending on the version of tornado, and warn if min tornado is higher than 2.2

Deprecation decorator:

@deprecated_since('2.3.1',will_remove='3.0.0')
def my_api('something'):
    """deprecated fucntion that should
    warn user when function is **called**

    when module version is >= 3.0, the decorator should warn **developper** at **compile** time
    that code has to be removed.
    """

This case is more interesting than support() as there is 2 pass, the decoration of the function itsef, and the execution of the function. will_remove should infer next major I guess. Should we add option to deprecate after/at a date for some case like API.

@deprecate_after(date='2015/10/15'):
def marty_from_the_future(self):
    """
    Docs has some invalid ssl certificates ?
    """

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
insupportable-0.1.2-py2.py3-none-any.whl (24.5 kB) Copy SHA256 hash SHA256 Wheel py2.py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page