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

iOS Snapchat parser for chats and cached files

ParseSnapchat iOS Snapchat parser for chats and cached files Tested on Windows and Linux install required libraries: pip install -r requirements.txt c

11 Dec 05, 2022

glip is a module for retrieve ip address like local-ip, global-ip, external-ip as string.

gle_ip_info glip is a module for retrieve ip address like local-ip, global-ip, external-ip as string.

3 Nov 21, 2021

Adding two matrix from scratch using python.

Adding-two-matrix-from-scratch-using-python. Here, I have take two matrix from user and add it without using any library. I made this program from scr

4 Sep 24, 2021

Data Utilities e.g. for importing files to onetask

Use this repository to easily convert your source files (csv, txt, excel, json, html) into record-oriented JSON files that can be uploaded into onetask.

1 Jul 18, 2022

Tools to connect to and interact with the Mila cluster

milatools The milatools package provides the mila command, which is meant to help with connecting to and interacting with the Mila cluster. Install Re

32 Dec 01, 2022

A time table app to notify the user about their class timings

kivyTimeTable A time table app to notify the user about their class timings Features This project incorporates some features i wanted to see in a time

2 Dec 15, 2021

Python code to divide big numbers

divide-big-num Python code to divide big numbers

1 Oct 15, 2021

This tool analyzes the json files generated by stream-lnd-htlcs to find hidden channel demand.

analyze_lnd_htlc Introduction Rebalancing channels is an important part of running a Lightning Network node. While it would be great if all channels c

4 Dec 08, 2022

Hide new MacBook Pro notch with black wallpaper.

1 Oct 27, 2021

A Python package implementing various colour checker detection algorithms and related utilities.

147 Dec 29, 2022

Python Random Number Genrator

This Genrates Random Numbers. This Random Number Generator was made using python. This software uses Time and Random extension. Download the EXE file and run it to get your answer.

2 Feb 03, 2022

Homebase Name Changer for Fortnite: Save the World.

Homebase Name Changer This program allows you to change the Homebase name in Fortnite: Save the World. How to use it? After starting the HomebaseNameC

7 May 21, 2022

EVE-NG tools, A Utility to make operations with EVE-NG more friendly.

EVE-NG tools, A Utility to make operations with EVE-NG more friendly. Also it support different snapshot operations with same style as Libvirt/KVM

8 Jan 05, 2023

An URL checking python module

6 Aug 10, 2022

ecowater-softner is a Python library for collecting information from Ecowater water softeners.

Ecowater Softner ecowater-softner is a Python library for collecting information from Ecowater water softeners. Installation Use the package manager p

6 Dec 08, 2022

A thing to simplify listening for PG notifications with asyncpg

18 Dec 23, 2022

A python package for your Kali Linux distro that find the fastest mirror and configure your apt to use that mirror

Kali Mirror Finder Using Single Python File A python package for your Kali Linux distro that find the fastest mirror and configure your apt to use tha

6 Dec 12, 2022

Finger is a function symbol recognition engine for binary programs

332 Jan 01, 2023

✨ Un générateur d'adresse IP aléatoire totalement fait en Python par moi, et en français.

IP Generateur ❗ Un générateur d'adresse IP aléatoire totalement fait en Python par moi, et en français. 🔮 Avec l'utilisation du module "random", j'ai

3 Jun 06, 2021

Experimental python optimistic rollup fraud-proof generation

Macula Experimental python optimistic rollup fraud-proof generation tech by @protolambda. Working on a python version for brevity and simplicity. See

30 Sep 01, 2022