Python @deprecat decorator to deprecate old python classes, functions or methods.

Last update: Dec 12, 2022

Related tags

Overview

deprecat Decorator

Python @deprecat decorator to deprecate old python classes, functions or methods.

Installation

pip install deprecat

Usage

To use this, decorate your deprecated function with @deprecat decorator:

from deprecat import deprecat


@deprecat
def some_old_function(x, y):
    return x + y

You can also decorate a class or a method:

from deprecated import deprecat


class SomeClass(object):
    @deprecat
    def some_old_method(self, x, y):
        return x + y


@deprecat
class SomeOldClass(object):
    pass

You can give a "reason" message to help the developer to choose another function/class:

from deprecat import deprecat


@deprecat(reason="use another function")
def some_old_function(x, y):
    return x + y

Authors

The authors of this library are: Marcos CARDOSO, and Laurent LAPORTE. The original code was made in this StackOverflow post by Leandro REGUEIRO, Patrizio BERTONI, and Eric WIESER.

Modified and now maintained by: Meenal Jhajharia

Comments

Decorator breaks when there's no "Parameters" section in the docstring

On a method that doesn't have a docstring at all, or is missing the expected section, the search result is None:

search = re.search("Parameters[\s]*\n[\s]*----------", docstring)
params_string = docstring[search.start():search.end()]

Traceback

...\deprecat\classic.py:217: in deprecat
    return wrapper_function(wrapped)
...\wrapt\decorators.py:417: in _wrapper
    return _build(target_wrapped, target_wrapper, _enabled, adapter)
...\wrapt\decorators.py:207: in _build
    adapter = adapter(wrapped)
...\deprecat\sphinx.py:145: in __call__
    params_string = docstring[search.start():search.end()]
E   AttributeError: 'NoneType' object has no attribute 'start'

opened by michaelosthege 2

Update tests

All the tests are unmodified and taken as it is from github:tantale/deprecated, we need to change them to suit the new features such as deprecated_args

opened by mjhajharia 2
Autogenerate the docstring examples

There is a https://deprecat.readthedocs.io/en/latest/source/usage.html#docstring section which is hardcoded in rST instead of showing the actual output.

I would try to create a showcase module inside the library that is not used by it nor exposed when imported but has one example of each deprecation type, class, function, method, kwarg... and then create a showcase api docs. I think this will serve also as a rudimentary test that the output looks as desired when doing changes in a way that automated tests can't

opened by OriolAbril 1
try quick fix

I don't really understand what the code is doing, but there seem to be some missing indent substitutions. I tried changing only this in case it helps. From https://github.com/pymc-devs/pymc/pull/5226 there is clearly an issue of missing indents.

opened by OriolAbril 1
Decorator breaks when the deprecated arg is not in the docstring
Very similar to #5 this line assumes that the deprecated kwarg is in the docstring:

description_start = re.search(f"\n{indent}{arg}\s*:", params_section).end()

...but again the search returns None if it's not found.
opened by michaelosthege 1

Releases(v2.1.1)

v2.1.1(Jan 27, 2022)
This release adds tests for the new features that deprecat adds on top of the original library that was forked (tantale/deprecated), namely:

tests for deprecated arguments warnings in functions, classes, static methods

tests for sphinx docstrings for deprecated arguments

Source code(tar.gz)
Source code(zip)
v2.1.0(Dec 1, 2021)

Bug fixes
Source code(tar.gz)
Source code(zip)
v2.0.0(Nov 5, 2021)
Everything is functional

Soon there'll be a new release with updated tests

Source code(tar.gz)
Source code(zip)

Owner

GitHub Repository

Tool for generating Memory.scan() compatible instruction search patterns

scanpat Tool for generating Frida Memory.scan() compatible instruction search patterns. Powered by r2. Examples $ ./scanpat.py arm.ks:64 'sub sp, sp,

13 Sep 19, 2022

Create powerful passwords easily and with many options with this program

Password_Generator About the Program: You can create powerful passwords with this program with many options easily! Features: You can copy the generat

0 Jul 14, 2022

Extract XML from the OS X dictionaries.

13 Dec 11, 2022

✨ Un chois aléatoire d'un article sur Wikipedia totalement fait en Python par moi, et en français.

Wikipedia Random Article ❗ Un chois aléatoire d'un article sur Wikipedia totalement fait en Python par moi, et en français. 🔮 Grâce a une requète a w

4 Jul 18, 2021

Color getter (including method to get random color or complementary color) made out of Python

python-color-getter Color getter (including method to get random color or complementary color) made out of Python Setup pip3 install git+https://githu

2 Sep 17, 2022

Create password - Generate Random Password with Passphrase

Generate Random Password with Passphrase This is a python code to generate stron

1 Jan 18, 2022

Various importers for cointracker

cointracker_importers Various importers for cointracker To convert nexo .csv format to cointracker .csv format: Download nexo csv file. run python Nex

9 Oct 24, 2022

一款不需要买代理来减少扫网站目录被封概率的扫描器，适用于中小规格字典。

PoorScanner使用说明书 -工具在不同环境下可能不怎么稳定，如果有什么问题恳请大家反馈。说明书有什么错误的地方也大家欢迎指正。更新记录 2021.8.23 修复了云函数主程序 gitee上传文件接口写错了的BUG（之前把自己的上传地址写死进去了，没从配置文件里读）更新了说明书 PoorS

14 Aug 02, 2022

A tool to create the basics of a project

Project-Scheduler Instalação Para instalar o Project Maker, você necessita está em um ambiente de desenvolvimento Linux ou wsl com alguma distro debia

2 Dec 17, 2021

A Container for the Dependency Injection in Python.

Python Dependency Injection library aiodi is a Container for the Dependency Injection in Python. Installation Use the package manager pip to install a

3 Nov 25, 2022

✨ Un générateur de mot de passe aléatoire totalement fait en Python par moi, et en français.

Password Generator ❗ Un générateur de mot de passe aléatoire totalement fait en Python par moi, et en français. 🔮 Grâce a une au module random et str

3 Jul 29, 2021

Parse URLs for DOIs, PubMed identifiers, PMC identifiers, arXiv identifiers, etc.

citation-url Parse URLs for DOIs, PubMed identifiers, PMC identifiers, arXiv identifiers, etc. This module has a single parse() function that takes in

2 Feb 12, 2022

Lock files using python and cmd

Python_Lock_Files Lock files using python and cmd license feel free to do whatever you want to with these files, i dont take any responsibility tho, u

1 Nov 01, 2021

A utility that makes it easy to work with Python projects containing lots of packages, of which you only want to develop some.

Mixed development source packages on top of stable constraints using pip mxdev [mɪks dɛv] is a utility that makes it easy to work with Python projects

6 Jun 08, 2022

Python @deprecat decorator to deprecate old python classes, functions or methods.

Related tags

Overview

deprecat Decorator

Installation

Usage

Authors

Comments

Decorator breaks when there's no "Parameters" section in the docstring

Update tests

Autogenerate the docstring examples

try quick fix

Decorator breaks when the deprecated arg is not in the docstring

Releases(v2.1.1)

v2.1.1(Jan 27, 2022)

v2.1.0(Dec 1, 2021)

v2.0.0(Nov 5, 2021)