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

A python script to generate wallpaper

wallpaper eits Warning You need to set the path to Robot Mono font in the source code. (Settings are in the main function) Usage A script that given a

5 Dec 02, 2021

A python app which aggregates and splits costs from multiple public cloud providers into a csv

Cloud Billing This project aggregates the costs public cloud resources by accounts, services and tags by importing the invoices from public cloud prov

1 Oct 04, 2022

Package that allows for validate and sanitize of string values.

py.validator A library of string validators and sanitizers Insipired by validator.js Strings only This library validates and sanitizes strings only. P

22 Nov 08, 2022

This python program will display all SSID usernames and SSID passwords you once connected to your laptop

Windows-Wifi-password-extractor This python program will display all SSID usernames and SSID passwords you once connected to your laptop How to run th

3 Apr 26, 2022

Python tool to check a web applications compliance with OWASP HTTP response headers best practices

Check Your Head A quick and easy way to check a web applications response headers!

6 Nov 09, 2021

A functional standard library for Python.

Toolz A set of utility functions for iterators, functions, and dictionaries. See the PyToolz documentation at https://toolz.readthedocs.io LICENSE New

4.1k Dec 30, 2022

A simple and easy to use collection of random python functions.

1 Nov 17, 2021

Shut is an opinionated tool to simplify publishing pure Python packages.

Welcome to Shut Shut is an opinionated tool to simplify publishing pure Python packages. What can Shut do for you? Generate setup files (setup.py, MAN

6 Nov 18, 2022

A python mathematics module

4 Nov 28, 2021

Library for processing molecules and reactions in python way

Chython [ˈkʌɪθ(ə)n] Library for processing molecules and reactions in python way. Features: Read/write/convert formats: MDL .RDF (.RXN) and .SDF (.MOL

16 Dec 01, 2022

Greenery - tools for parsing and manipulating regular expressions

242 Dec 15, 2022

Python program to do with percentages and chances, random generation.

Chances and Percentages Python program to do with percentages and chances, random generation. What is this? This small program will generate a list wi

3 Jul 15, 2021

cpp20.py is a Python script to compile C++20 code using modules.

cpp20.py is a Python script to compile C++20 code using modules. It browses the source files to determine their dependencies. Then, it compiles then in order using the correct flags.

6 Aug 26, 2022

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

NetConfParser is a tool that helps you analyze the rpcs coming and going from a netconf client to a server

1 Mar 31, 2022

Let's renew the puzzle collection. We'll produce a collection of new puzzles out of the lichess game database.

96 Jan 03, 2023

Simple RGB to HEX game made in python

5 Aug 26, 2022

Trying to replicate (albeit unsuccessfully) the phenomenon of boids using Ursina in a naive manner.

Boids_Boi Trying to replicate (albeit unsuccessfully) the phenomenon of boids using Ursina in a naive manner. Please install the Ursina module before

2 Oct 19, 2021

JeNot - A tool to notify you when Jenkins builds are done.

JeNot - Jenkins Notifications NOTE: under construction, buggy, and not production-ready What A tool to notify you when Jenkins builds are done. Why Je

1 Jun 24, 2022

SH-PUBLIC is a python based cloning script. You can clone unlimited UID facebook accounts by using this tool.

SH-PUBLIC is a python based cloning script. You can clone unlimited UID facebook accounts by using this tool. This tool works on any Android devices without root.

5 Mar 09, 2022